---

KCombiView Class Reference

#include <kcombiview.h>

Inheritance diagram for KCombiView:

List of all members.

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 ()
void	setRight (KFileView *view)
virtual void	setSelectionMode (KFile::SelectionMode sm)
virtual void	setSelected (const KFileItem *, bool)
virtual bool	isSelected (const KFileItem *) 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
virtual void	insertItem (KFileItem *i)
virtual void	clear ()
virtual void	setSorting (QDir::SortSpec sort)
virtual void	readConfig (KConfig *, const QString &group=QString::null)
virtual void	writeConfig (KConfig *, const QString &group=QString::null)
void	ensureItemVisible (const KFileItem *)
virtual KActionCollection *	actionCollection () const
Protected Methods
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

This view is designed to combine two KFileViews into one widget, to show directories on the left side and files on the right side.

Methods like selectedItems() to query status _only_ work on the right side, i.e. on the files.

After creating the KCombiView, you need to supply the view shown in the right, (see setRight()). Available KFileView implementations are KFileIconView and KFileDetailView.

Most of the below methods are just implementations of the baseclass KFileView, so look there for documentation.

See also:

KFileView , KFileIconView , KFileDetailView , KDirOperator

Definition at line 53 of file kcombiview.h.

---

Member Function Documentation

virtual KActionCollection* KCombiView::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 from KFileView.

virtual void KCombiView::clear (    )  [virtual]

Clears the view and all item lists. Reimplemented from KFileView.

virtual void KCombiView::clearSelection (    )  [virtual]

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

virtual void KCombiView::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* KCombiView::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 KCombiView::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 KCombiView::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 KCombiView::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 KCombiView::isSelected (  const KFileItem *    )  const [virtual]

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

virtual void KCombiView::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 KCombiView::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 KCombiView::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 KCombiView::setCurrentItem (  const KFileItem *    )  [virtual]

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

void KCombiView::setRight (  KFileView *    view )

Sets the view to be shown in the right. You need to call this before doing anything else with this widget.

virtual void KCombiView::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 KCombiView::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.

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

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

virtual QWidget* KCombiView::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 62 of file kcombiview.h.

---

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

• kcombiview.h

---