---

KFileView Class Reference

A base class for views of the KDE file selector. More...

#include <kfileview.h>

Inheritance diagram for KFileView:

List of all members.

Public Methods
virtual	~KFileView ()
void	addItemList (const KFileItemList &list)
virtual QWidget *	widget ()=0
QWidget *	widget () const
void	setCurrentItem (const QString &filename)
virtual void	setCurrentItem (const KFileItem *item)=0
virtual KFileItem *	currentFileItem () const=0
virtual void	clear ()
virtual void	updateView (bool f=true)
virtual void	removeItem (const KFileItem *item)
virtual void	listingCompleted ()
QDir::SortSpec	sorting () const
virtual void	setSorting (QDir::SortSpec sort)
bool	isReversed () const
uint	count () const
uint	numFiles () const
uint	numDirs () const
QString	viewName () const
void	setViewName (const QString &name)
virtual void	insertItem (KFileItem *i)
virtual void	clearView ()=0
virtual void	ensureItemVisible (const KFileItem *i)=0
virtual void	clearSelection ()=0
virtual void	selectAll ()
virtual void	invertSelection ()
virtual void	setSelected (const KFileItem *, bool enable)=0
virtual bool	isSelected (const KFileItem *) const=0
const KFileItemList *	selectedItems () const
const KFileItemList *	items () const
void	setOnlyDoubleClickSelectsFiles (bool enable)
bool	onlyDoubleClickSelectsFiles () const
bool	updateNumbers (const KFileItem *i)
virtual KActionCollection *	actionCollection () const
Static Public Methods
QString	sortingKey (const QString &value, bool isDir, int sortSpec)
QString	sortingKey (KIO::filesize_t value, bool isDir, int sortSpec)

---

Detailed Description

A base class for views of the KDE file selector.

This class defines an interface to all file views. Its intent is to allow to switch the view of the files in the selector very easily. It defines some pure virtual functions, that must be implemented to make a file view working.

Since this class is not a widget, but it's meant to be added to other widgets, its most important function is widget. This should return a pointer to the implemented widget.

Author:

Stephan Kulow <coolo@kde.org>

Version:

Id:

kfileview.h,v 1.44 2002/08/02 08:35:37 coolo Exp

Definition at line 94 of file kfileview.h.

---

Constructor & Destructor Documentation

virtual KFileView::~KFileView (    )  [virtual]

Destructor

---

Member Function Documentation

virtual KActionCollection* KFileView::actionCollection (    )  [virtual]

Returns: the view-specific action-collection. Every view should add its actions here (if it has any) to make them available to e.g. the KDirOperator's popup-menu. Reimplemented in KCombiView, and KFilePreview.

void KFileView::addItemList (  const KFileItemList &    list )

inserts a list of items.

virtual void KFileView::clear (    )  [virtual]

Clears the view and all item lists. Reimplemented in KCombiView, and KFilePreview.

virtual void KFileView::clearSelection (    )  [pure virtual]

Clears any selection, unhighlights everything. Must be implemented by the view. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

virtual void KFileView::clearView (    )  [pure virtual]

pure virtual function, that should be implemented to clear the view. At this moment the list is already empty Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

uint KFileView::count (    )  const [inline]

Returns: the number of dirs and files Definition at line 200 of file kfileview.h.

virtual KFileItem* KFileView::currentFileItem (    )  [pure 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. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

virtual void KFileView::ensureItemVisible (  const KFileItem *    i )  [pure virtual]

pure virtual function, that should be implemented to make item i visible, i.e. by scrolling the view appropriately. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

virtual void KFileView::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 in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

virtual void KFileView::invertSelection (    )  [virtual]

Inverts the current selection, i.e. selects all items, that were up to now not selected and deselects the other. Reimplemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

bool KFileView::isReversed (    )  const [inline]

Tells whether the current items are in reversed order (shortcut to sorting() & QDir::Reversed). Definition at line 193 of file kfileview.h.

virtual bool KFileView::isSelected (  const KFileItem *    )  const [pure virtual]

Returns: whether the given item is currently selected. Must be implemented by the view. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview. Referenced by KDirOperator::isSelected().

const KFileItemList* KFileView::items (    )

Returns: all items currently available in the current sort-order

virtual void KFileView::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 in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

uint KFileView::numDirs (    )  const [inline]

Returns: the number of directories Definition at line 210 of file kfileview.h.

uint KFileView::numFiles (    )  const [inline]

Returns: the number of files. Definition at line 205 of file kfileview.h.

bool KFileView::onlyDoubleClickSelectsFiles (    )  const [inline]

Returns: whether files (not directories) should only be select()ed by double-clicks. See also: setOnlyDoubleClickSelectsFiles Definition at line 324 of file kfileview.h.

virtual void KFileView::removeItem (  const KFileItem *    item )  [virtual]

Removes an item from the list; has to be implemented by the view. Call KFileView::removeItem( item ) after removing it. Reimplemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

virtual void KFileView::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 in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

const KFileItemList* KFileView::selectedItems (    )

Returns: all currently highlighted items. Referenced by KDirOperator::selectedItems().

virtual void KFileView::setCurrentItem (  const KFileItem *    item )  [pure virtual]

Reimplement this to set item the current item in the view, e.g. the item having focus. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

void KFileView::setCurrentItem (  const QString &    filename )

Sets filename the current item in the view, if available.

void KFileView::setOnlyDoubleClickSelectsFiles (  bool    enable )  [inline]

This is a KFileDialog specific hack: we want to select directories with single click, but not files. But as a generic class, we have to be able to select files on single click as well. This gives us the opportunity to do both. Every view has to decide when to call select( item ) when a file was single-clicked, based on onlyDoubleClickSelectsFiles(). Definition at line 315 of file kfileview.h.

virtual void KFileView::setSelected (  const KFileItem *   , bool    enable )  [pure virtual]

Tells the view that it should highlight the item. This function must be implemented by the view. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

virtual void KFileView::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 in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

void KFileView::setViewName (  const QString &    name )  [inline]

Sets the name of the view, which could be displayed somewhere. E.g. "Image Preview". Definition at line 234 of file kfileview.h.

QDir::SortSpec KFileView::sorting (    )  const [inline]

Returns the sorting order of the internal list. Newly added files are added through this sorting. Definition at line 171 of file kfileview.h.

QString KFileView::sortingKey (  KIO::filesize_t    value, bool    isDir, int    sortSpec )  [static]

An overloaded method that takes not a QString, but a number as sort criterion. You can use this for file-sizes or dates/times for example. If you use a time_t, you need to cast that to KIO::filesize_t because of ambiguity problems.

QString KFileView::sortingKey (  const QString &    value, bool    isDir, int    sortSpec )  [static]

This method calculates a QString from the given parameters, that is suitable for sorting with e.g. QIconView or QListView. Their Item-classes usually have a setKey( const QString& ) method or a virtual method QString key() that is used for sorting. Parameters: value  Any string that should be used as sort criterion isDir  Tells whether the key is computed for an item representing a directory (directories are usually sorted before files) sortSpec  An ORed combination of QDir::SortSpec flags. Currently, the values IgnoreCase, Reversed and DirsFirst are taken into account.

bool KFileView::updateNumbers (  const KFileItem *    i )

increases the number of dirs and files. Returns: true if the item fits the view mode

virtual void KFileView::updateView (  bool    f = true )  [virtual]

does a repaint of the view. The default implementation calls widget()->repaint(f) Reimplemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview.

QString KFileView::viewName (    )  const [inline]

Returns: the localized name of the view, which could be displayed somewhere, e.g. in a menu, where the user can choose between views. See also: setViewName Definition at line 228 of file kfileview.h.

QWidget* KFileView::widget (    )  const [inline]

### As const-method, to be fixed in 3.0 Definition at line 119 of file kfileview.h.

virtual QWidget* KFileView::widget (    )  [pure 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. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview. Referenced by KDirOperator::viewWidget().

---

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

• kfileview.h

---