class KFileTreeView

# class KFileTreeView | The filetreeview offers a treeview on the file system which behaves like a QTreeView showing files and/or directories in the file system. More...
Definition | `#include <kfiletreeview.h>`
Inherits | KListView (kdeui) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KFileTreeView ( QWidget *parent, const char *name = 0 )
- virtual ~KFileTreeView ()
- KFileTreeViewItem * currentKFileTreeViewItem () const
- KURL currentURL () const
- KFileTreeBranch* addBranch ( const KURL &path, const QString& name, bool showHidden = false )
- virtual KFileTreeBranch* addBranch ( const KURL &path, const QString& name , const QPixmap& pix, bool showHidden = false )
- virtual KFileTreeBranch* addBranch ( KFileTreeBranch * )
- virtual bool removeBranch ( KFileTreeBranch *branch )
- KFileTreeBranch * branch ( const QString& searchName )
- KFileTreeBranchList& branches ()
- virtual void setDirOnlyMode ( KFileTreeBranch *brnch, bool )
- KFileTreeViewItem * findItem ( KFileTreeBranch* brnch, const QString& relUrl )
- KFileTreeViewItem * findItem ( const QString& branchName, const QString& relUrl )
- bool showFolderOpenPixmap () const

#### Public Slots

- virtual void setShowFolderOpenPixmap ( bool showIt = true )

#### Signals

- void onItem ( const QString& )
- void dropped ( QWidget*, QDropEvent* )
- void dropped ( QWidget*, QDropEvent*, KURL::List& )
- void dropped ( KURL::List&, KURL& )
- void dropped ( QDropEvent *, QListViewItem * )
- void dropped (KFileTreeView *, QDropEvent *, QListViewItem *)
- void dropped (QDropEvent *, QListViewItem *, QListViewItem *)
- void dropped (KFileTreeView *, QDropEvent *, QListViewItem *, QListViewItem *)

#### Protected Methods

- virtual bool acceptDrag (QDropEvent* event) const
- virtual QDragObject * dragObject ()
- virtual void startAnimation ( KFileTreeViewItem* item, const char * iconBaseName = "kde", uint iconCount = 6 )
- virtual void stopAnimation ( KFileTreeViewItem* item )
- virtual void contentsDragEnterEvent ( QDragEnterEvent *e )
- virtual void contentsDragMoveEvent ( QDragMoveEvent *e )
- virtual void contentsDragLeaveEvent ( QDragLeaveEvent *e )
- virtual void contentsDropEvent ( QDropEvent *ev )
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- virtual void slotNewTreeViewItems ( KFileTreeBranch*, const KFileTreeViewItemList& )
- virtual void slotSetNextUrlToSelect ( const KURL &url )
- virtual QPixmap itemIcon ( KFileTreeViewItem*, int gap = 0 ) const

#### Protected Members

- KURL m_nextUrlToSelect

## Detailed Description

The filetreeview offers a treeview on the file system which behaves like a QTreeView showing files and/or directories in the file system.

KFileTreeView is able to handle more than one URL, represented by KFileTreeBranch.

Typical usage: 1. create a KFileTreeView fitting in your layout and add columns to it 2. call addBranch to create one or more branches 3. retrieve the root item with KFileTreeBranch::root() and set it open if desired. That starts the listing.

KFileTreeView ( QWidget *parent, const char *name = 0 ) | ### KFileTreeView

~KFileTreeView () | ### ~KFileTreeView

[virtual]

KFileTreeViewItem * currentKFileTreeViewItem () | ### currentKFileTreeViewItem

[const]

Returns: the current (i.e. selected) item

KURL currentURL () | ### currentURL

[const]

Returns: the URL of the current selected item.

KFileTreeBranch* addBranch ( const KURL &path, const QString& name, bool showHidden = false ) | ### addBranch

Adds a branch to the treeview item.

This high-level function creates the branch, adds it to the treeview and connects some signals. Note that directory listing does not start until a branch is expanded either by opening the root item by user or by setOpen on the root item.

Parameters:

path | is the base url of the branch
name | is the name of the branch, which will be the text for column 0
showHidden | says if hidden files and directories should be visible

Returns: a pointer to the new branch or zero

KFileTreeBranch* addBranch ( const KURL &path, const QString& name , const QPixmap& pix, bool showHidden = false ) | ### addBranch

[virtual]

same as the function above but with a pixmap to set for the branch.

KFileTreeBranch* addBranch ( KFileTreeBranch * ) | ### addBranch

[virtual]

same as the function above but letting the user create the branch.

bool removeBranch ( KFileTreeBranch *branch ) | ### removeBranch

[virtual]

removes the branch from the treeview.

Parameters:

branch | is a pointer to the branch

Returns: true on success.

KFileTreeBranch * branch ( const QString& searchName ) | ### branch

Parameters:

branchno | is the name of a branch

Returns: a pointer to the KFileTreeBranch in the KFileTreeView or zero on failiure.

KFileTreeBranchList& branches () | ### branches

Returns: a list of pointers to all existing branches in the treeview.

void setDirOnlyMode ( KFileTreeBranch *brnch, bool ) | ### setDirOnlyMode

[virtual]

set the directory mode for branches. If true is passed, only directories will be loaded.

Parameters:

branch | is a pointer to a KFileTreeBranch

KFileTreeViewItem * findItem ( KFileTreeBranch* brnch, const QString& relUrl ) | ### findItem

searches a branch for a KFileTreeViewItem identified by the relative url given as second parameter. The method adds the branches base url to the relative path and finds the item.

Parameters:

brnch | is a pointer to the branch to search in
relUrl | is the branch relativ url

Returns: a pointer to the item or zero if the item does not exist.

KFileTreeViewItem * findItem ( const QString& branchName, const QString& relUrl ) | ### findItem

see method above, differs only in the first parameter. Finds the branch by its name.

bool showFolderOpenPixmap () | ### showFolderOpenPixmap

[const]

Returns: a flag indicating if extended folder pixmaps are displayed or not.

void setShowFolderOpenPixmap ( bool showIt = true ) | ### setShowFolderOpenPixmap

[virtual slot]

set the flag to show 'extended' folder icons on or off. If switched on, folders will have an open folder pixmap displayed if their children are visible, and the standard closed folder pixmap (from mimetype folder) if they are closed. If switched off, the plain mime pixmap is displayed.

Parameters:

showIt | = false displays mime type pixmap only

bool acceptDrag (QDropEvent* event) | ### acceptDrag

[protected const virtual]

Returns: true if we can decode the drag and support the action

Reimplemented from KListView.

QDragObject * dragObject () | ### dragObject

[protected virtual]

Reimplemented from KListView.

void startAnimation ( KFileTreeViewItem* item, const char * iconBaseName = "kde", uint iconCount = 6 ) | ### startAnimation

[protected virtual]

void stopAnimation ( KFileTreeViewItem* item ) | ### stopAnimation

[protected virtual]

void contentsDragEnterEvent ( QDragEnterEvent *e ) | ### contentsDragEnterEvent

[protected virtual]

Reimplemented from KListView.

void contentsDragMoveEvent ( QDragMoveEvent *e ) | ### contentsDragMoveEvent

[protected virtual]

Reimplemented from KListView.

void contentsDragLeaveEvent ( QDragLeaveEvent *e ) | ### contentsDragLeaveEvent

[protected virtual]

Reimplemented from KListView.

void contentsDropEvent ( QDropEvent *ev ) | ### contentsDropEvent

[protected virtual]

Reimplemented from KListView.

void slotNewTreeViewItems ( KFileTreeBranch*, const KFileTreeViewItemList& ) | ### slotNewTreeViewItems

[protected slots virtual slot]

void slotSetNextUrlToSelect ( const KURL &url ) | ### slotSetNextUrlToSelect

[protected slots virtual slot]

QPixmap itemIcon ( KFileTreeViewItem*, int gap = 0 ) | ### itemIcon

[protected slots const virtual slot]

void onItem ( const QString& ) | ### onItem

[signal]

void dropped ( QWidget*, QDropEvent* ) | ### dropped

[signal]

Reimplemented from KListView.

void dropped ( QWidget*, QDropEvent*, KURL::List& ) | ### dropped

[signal]

Reimplemented from KListView.

void dropped ( KURL::List&, KURL& ) | ### dropped

[signal]

Reimplemented from KListView.

void dropped ( QDropEvent *, QListViewItem * ) | ### dropped

[signal]

Reimplemented from KListView.

void dropped (KFileTreeView *, QDropEvent *, QListViewItem *) | ### dropped

[signal]

Reimplemented from KListView.

void dropped (QDropEvent *, QListViewItem *, QListViewItem *) | ### dropped

[signal]

Reimplemented from KListView.

void dropped (KFileTreeView *, QDropEvent *, QListViewItem *, QListViewItem *) | ### dropped

[signal]

Reimplemented from KListView.

KURL m_nextUrlToSelect | ### m_nextUrlToSelect

[protected]

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from KListView.

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:17 2003, using kdoc 2.0a54.