# kio Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# KFileView Class Reference

This class defines an interface to all file views. A base class for views of the KDE file selector. More...

`#include <kfileview.h>`

Inheritance diagram for KFileView:

[legend]
Collaboration diagram for KFileView:

[legend]
List of all members.

## Public Types

enum | ViewMode { Files = 1, Directories = 2, All = Files | Directories }
enum | DropOptions { AutoOpenDirs = 1 }

## Public Member Functions

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 | updateView (const KFileItem *)
virtual void | removeItem (const KFileItem *item)
virtual void | listingCompleted ()
QDir::SortSpec | sorting () const
virtual void | setSorting (QDir::SortSpec sort)
bool | isReversed () const
void | sortReversed ()
uint | count () const
uint | numFiles () const
uint | numDirs () const
virtual void | setSelectionMode (KFile::SelectionMode sm)
virtual KFile::SelectionMode | selectionMode () const
virtual void | setViewMode (ViewMode vm)
virtual ViewMode | viewMode () const
QString | viewName () const
void | setViewName (const QString &name)
virtual void | setParentView (KFileView *parent)
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
virtual KFileItem * | firstFileItem () const =0
virtual KFileItem * | nextItem (const KFileItem *) const =0
virtual KFileItem * | prevItem (const KFileItem *) const =0
void | setOnlyDoubleClickSelectsFiles (bool enable)
bool | onlyDoubleClickSelectsFiles () const
bool | updateNumbers (const KFileItem *i)
virtual KActionCollection * | actionCollection () const
KFileViewSignaler * | signaler () const
virtual void | readConfig (KConfig *, const QString &group=QString::null)
virtual void | writeConfig (KConfig *, const QString &group=QString::null)
void | setDropOptions (int options)
int | dropOptions ()

## Static Public Member Functions

static QString | sortingKey (const QString &value, bool isDir, int sortSpec)
static QString | sortingKey (KIO::filesize_t value, bool isDir, int sortSpec)
static int | autoOpenDelay ()

## Protected Types

enum | { VIRTUAL_SET_DROP_OPTIONS = 1 }

## Protected Member Functions

virtual void | virtual_hook (int id, void *data)
void | setDropOptions_impl (int options)

## Protected Attributes

KFileViewSignaler * | sig

## Detailed Description

This class defines an interface to all file views. A base class for views of the KDE file selector.

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>

Definition at line 98 of file kfileview.h.

## Member Enumeration Documentation

enum KFileView::DropOptions

Various options for drag and drop support.

These values can be or'd together.

- `AutoOpenDirs` Automatically open directory after hovering above it for a short while while dragging.
  Since:
    3.2

Definition at line 359 of file kfileview.h.

## Constructor & Destructor Documentation

KFileView::~KFileView | ( |  | ) | `[virtual]`

| Destructor. Definition at line 83 of file kfileview.cpp.

## Member Function Documentation

void KFileView::addItemList | ( | const KFileItemList & | list | ) |

| inserts a list of items. Definition at line 130 of file kfileview.cpp. References insertItem(), and updateNumbers(). Referenced by KDirOperator::insertNewFiles().

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 actionCollection(), KDirOperator::createView(), KDirOperator::setAcceptDrops(), KCombiView::setRight(), KDirOperator::setView(), and updateView().

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

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

void KFileView::setCurrentItem | ( | const QString & | filename | ) |

| Sets `filename` the current item in the view, if available. Definition at line 268 of file kfileview.cpp. References endl(), kdDebug(), and KFileItem::name(). Referenced by KDirOperator::insertNewFiles(), KDirOperator::setCurrentItem(), and KCombiView::setCurrentItem().

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.

virtual KFileItem* KFileView::currentFileItem | ( |  | ) | const`[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.

Referenced by KCombiView::currentFileItem().

void KFileView::clear | ( |  | ) | `[virtual]`

| Clears the view and all item lists. Reimplemented in KCombiView, and KFilePreview. Definition at line 156 of file kfileview.cpp. References QPtrList::clear(), and clearView(). Referenced by KFilePreview::clear(), KCombiView::clear(), and KDirOperator::pathChanged().

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.

Definition at line 259 of file kfileview.cpp.

References QWidget::repaint(), and widget().

Referenced by KCombiView::updateView().

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.

Definition at line 346 of file kfileview.cpp.

References QPtrList::removeRef().

Referenced by KDirOperator::itemDeleted(), KFilePreview::removeItem(), KFileIconView::removeItem(), KFileDetailView::removeItem(), and KCombiView::removeItem().

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. Definition at line 360 of file kfileview.cpp. Referenced by KCombiView::listingCompleted(), and KDirOperator::updateDir().

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 177 of file kfileview.h. Referenced by KFilePreview::setFileView(), and KCombiView::setSorting().

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.

Definition at line 151 of file kfileview.cpp.

Referenced by KFilePreview::setSorting(), KFileIconView::setSorting(), KFileDetailView::setSorting(), KDirOperator::setSorting(), KCombiView::setSorting(), and KDirOperator::setView().

bool KFileView::isReversed | ( |  | ) | const`[inline]`

| Tells whether the current items are in reversed order (shortcut to sorting() & QDir::Reversed). Definition at line 199 of file kfileview.h. Referenced by KFileIconView::setSorting(), and KDirOperator::updateSortActions().

uint KFileView::count | ( |  | ) | const`[inline]`

Returns:
  the number of dirs and files

Definition at line 206 of file kfileview.h.

uint KFileView::numFiles | ( |  | ) | const`[inline]`

Returns:
  the number of files.

Definition at line 211 of file kfileview.h.

Referenced by KDirOperator::insertNewFiles(), KDirOperator::itemDeleted(), and KDirOperator::numFiles().

uint KFileView::numDirs | ( |  | ) | const`[inline]`

Returns:
  the number of directories

Definition at line 216 of file kfileview.h.

Referenced by KDirOperator::insertNewFiles(), KDirOperator::itemDeleted(), and KDirOperator::numDirs().

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 234 of file kfileview.h.

Referenced by KCombiView::setRight().

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 240 of file kfileview.h. Referenced by KDirOperator::createView(), and KCombiView::setRight().

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.

Definition at line 147 of file kfileview.cpp.

Referenced by addItemList(), KFilePreview::insertItem(), KFileIconView::insertItem(), KFileDetailView::insertItem(), and KCombiView::insertItem().

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. Referenced by clear(), and KCombiView::clearView().

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. Referenced by KCombiView::ensureItemVisible(), KDirOperator::insertNewFiles(), and KDirOperator::setCurrentItem().

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

| Clears any selection, unhighlights everything. Must be implemented by the view. Implemented in KCombiView, KFileDetailView, KFileIconView, and KFilePreview. Referenced by KCombiView::clearSelection(), KDirOperator::makeCompletion(), KDirOperator::makeDirCompletion(), and KDirOperator::setCurrentItem().

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. Definition at line 312 of file kfileview.cpp. References setSelected(). Referenced by KCombiView::selectAll().

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. Definition at line 323 of file kfileview.cpp. References isSelected(), and setSelected(). Referenced by KCombiView::invertSelection().

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. Referenced by invertSelection(), selectAll(), KDirOperator::setCurrentItem(), and KCombiView::setSelected().

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 invertSelection(), KCombiView::isSelected(), and selectedItems().

const KFileItemList * KFileView::selectedItems | ( |  | ) | const

Returns:
  all currently highlighted items.

Definition at line 296 of file kfileview.cpp.

References QPtrList::append(), QPtrList::clear(), and isSelected().

Referenced by KDirOperator::deleteSelected(), KDirOperator::trashSelected(), and KDirOperator::updateSelectionDependentActions().

const KFileItemList * KFileView::items | ( |  | ) | const

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

Definition at line 283 of file kfileview.cpp.

References QPtrList::append(), and QPtrList::clear().

Referenced by KDirOperator::prepareCompletionObjects(), KFileIconView::setSorting(), and KFileIconView::showPreviews().

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 321 of file kfileview.h.

Referenced by KDirOperator::createView(), KDirOperator::setOnlyDoubleClickSelectsFiles(), and KDirOperator::setView().

bool KFileView::onlyDoubleClickSelectsFiles | ( |  | ) | const`[inline]`

Returns:
  whether files (not directories) should only be select()ed by double-clicks.

See also:
  setOnlyDoubleClickSelectsFiles

Definition at line 330 of file kfileview.h.

Referenced by KDirOperator::onlyDoubleClickSelectsFiles().

bool KFileView::updateNumbers | ( | const KFileItem * | i | ) |

increases the number of dirs and files.

Returns:
  true if the item fits the view mode

Definition at line 110 of file kfileview.cpp.

Referenced by addItemList(), and KCombiView::insertItem().

KActionCollection * KFileView::actionCollection | ( |  | ) | const`[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.

Definition at line 365 of file kfileview.cpp.

References KActionCollection::actions(), and widget().

Referenced by KFilePreview::actionCollection(), and KCombiView::actionCollection().

void KFileView::setDropOptions | ( | int | options | ) |

Specify DND options.

See DropOptions for details. All options are disabled by default.

Since:
  3.2

Definition at line 397 of file kfileview.cpp.

Referenced by KDirOperator::setDropOptions(), and KCombiView::setRight().

int KFileView::dropOptions | ( |  | ) |

Returns the DND options in effect.

See DropOptions for details.

Since:
  3.2

Definition at line 407 of file kfileview.cpp.

Referenced by KCombiView::setRight().

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.

Definition at line 380 of file kfileview.cpp.

References QString::lower(), and QString::prepend().

Referenced by KFileIconView::setSorting().

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. Definition at line 389 of file kfileview.cpp. References KIO::number(), QString::prepend(), and QString::rightJustify().

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

- kfileview.h
- kfileview.cpp

This file is part of the documentation for kio Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:24:50 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003