---

KFileIconView Class Reference

#include <kfileiconview.h>

Inheritance diagram for KFileIconView:

List of all members.

Public Slots
void	showPreviews ()
virtual void	arrangeItemsInGrid (bool updated=true)
Public Methods
virtual QWidget *	widget ()
virtual void	clearView ()
virtual void	updateView (bool)
virtual void	updateView (const KFileItem *)
virtual void	removeItem (const KFileItem *)
virtual void	listingCompleted ()
virtual void	insertItem (KFileItem *i)
virtual void	setSelectionMode (KFile::SelectionMode sm)
virtual void	setSelected (const KFileItem *, bool)
virtual bool	isSelected (const KFileItem *i) const
virtual void	clearSelection ()
virtual void	selectAll ()
virtual void	invertSelection ()
virtual void	setCurrentItem (const KFileItem *)
virtual KFileItem *	currentFileItem () const
virtual KFileItem *	firstFileItem () const
virtual KFileItem *	nextItem (const KFileItem *) const
virtual KFileItem *	prevItem (const KFileItem *) const
void	setIconSize (int size)
void	setPreviewSize (int size)
int	iconSize () const
void	ensureItemVisible (const KFileItem *)
virtual void	setSorting (QDir::SortSpec sort)
virtual void	readConfig (KConfig *, const QString &group=QString::null)
virtual void	writeConfig (KConfig *, const QString &group=QString::null)
Protected Methods
virtual void	keyPressEvent (QKeyEvent *)
virtual void	hideEvent (QHideEvent *)
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

An icon-view capable of showing KFileItem's. Used in the filedialog for example. Most of the documentation is in KFileView class.

See also:

KDirOperator , KCombiView , KFileDetailView

Definition at line 82 of file kfileiconview.h.

---

Member Function Documentation

virtual void KFileIconView::arrangeItemsInGrid (  bool    updated = true )  [virtual, slot]

Reimplemented for performance reasons. Since: 3.1

virtual void KFileIconView::clearSelection (    )  [virtual]

Clears any selection, unhighlights everything. Must be implemented by the view. Implements KFileView.

virtual void KFileIconView::clearView (    )  [virtual]

pure virtual function, that should be implemented to clear the view. At this moment the list is already empty Implements KFileView.

virtual KFileItem* KFileIconView::currentFileItem (    )  [virtual]

Returns: the "current" KFileItem, 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. Implements KFileView.

void KFileIconView::ensureItemVisible (  const KFileItem *    )  [virtual]

pure virtual function, that should be implemented to make item i visible, i.e. by scrolling the view appropriately. Implements KFileView.

virtual void KFileIconView::hideEvent (  QHideEvent *    )  [protected, virtual]

Reimplemented to remove an eventual tooltip

int KFileIconView::iconSize (    )  const [inline]

Returns: the current size used for icons. Definition at line 128 of file kfileiconview.h.

virtual void KFileIconView::insertItem (  KFileItem *    i )  [virtual]

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 KFileView.

virtual void KFileIconView::invertSelection (    )  [virtual]

Inverts the current selection, i.e. selects all items, that were up to now not selected and deselects the other. Reimplemented from KFileView.

virtual bool KFileIconView::isSelected (  const KFileItem *    i )  const [virtual]

Returns: whether the given item is currently selected. Must be implemented by the view. Implements KFileView.

virtual void KFileIconView::keyPressEvent (  QKeyEvent *    )  [protected, virtual]

Reimplemented to not let QIconView eat return-key events

virtual void KFileIconView::listingCompleted (    )  [virtual]

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 KFileView.

virtual void KFileIconView::removeItem (  const KFileItem *    )  [virtual]

Removes an item from the list; has to be implemented by the view. Call KFileView::removeItem( item ) after removing it. Reimplemented from KFileView.

virtual void KFileIconView::selectAll (    )  [virtual]

Selects all items. You may want to override this, if you can implement it more efficiently than calling setSelected() with every item. This works only in Multiselection mode of course. Reimplemented from KFileView.

virtual void KFileIconView::setCurrentItem (  const KFileItem *    )  [virtual]

Reimplement this to set item the current item in the view, e.g. the item having focus. Implements KFileView.

void KFileIconView::setIconSize (  int    size )

Sets the size of the icons to show. Defaults to KIcon::SizeSmall.

void KFileIconView::setPreviewSize (  int    size )

Sets the size of the previews. Defaults to KIcon::SizeLarge.

virtual void KFileIconView::setSelected (  const KFileItem *   , bool    )  [virtual]

Tells the view that it should highlight the item. This function must be implemented by the view. Implements KFileView.

virtual void KFileIconView::setSorting (  QDir::SortSpec    sort )  [virtual]

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 QIconView or QListView to sort. 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. See also: sortingKey Reimplemented from KFileView.

void KFileIconView::showPreviews (    )  [slot]

Starts loading previews for all files shown and shows them. Switches into 'large rows' mode, if that isn't the current mode yet.

virtual void KFileIconView::updateView (  bool    )  [virtual]

does a repaint of the view. The default implementation calls widget()->repaint(f) Reimplemented from KFileView.

virtual QWidget* KFileIconView::widget (    )  [inline, virtual]

a pure virtual function to get a QWidget, that can be added to other widgets. This function is needed to make it possible for derived classes to derive from other widgets. Implements KFileView. Definition at line 90 of file kfileiconview.h.

---

The documentation for this class was generated from the following file:

• kfileiconview.h

---