Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KFileTreeView Class Reference

#include <kfiletreeview.h>

Inheritance diagram for KFileTreeView:

KListView List of all members.

Public Slots

virtual void setShowFolderOpenPixmap (bool showIt=true)

Signals

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

Public Methods

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

Protected Methods

virtual bool acceptDrag (QDropEvent *event) const
virtual QDragObject * dragObject ()
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)

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.

Definition at line 66 of file kfiletreeview.h.

Member Function Documentation

virtual bool KFileTreeView::acceptDrag (  QDropEvent *    event )  const [protected, virtual]
 

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

Reimplemented from KListView.

virtual KFileTreeBranch* KFileTreeView::addBranch (  KFileTreeBranch *    )  [virtual]
 

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

virtual KFileTreeBranch* KFileTreeView::addBranch (  const KURL &    path,
const QString &    name,
const QPixmap &    pix,
bool    showHidden = false
)  [virtual]
 

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

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

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.

Returns:
a pointer to the new branch or zero
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

KFileTreeBranch* KFileTreeView::branch (  const QString &    searchName ) 
 

Returns:
a pointer to the KFileTreeBranch in the KFileTreeView or zero on failiure.
Parameters:
branchno  is the name of a branch

KFileTreeBranchList& KFileTreeView::branches (    ) 
 

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

virtual void KFileTreeView::contentsDragEnterEvent (  QDragEnterEvent *    e )  [protected, virtual]
 

Reimplemented for internal reasons. Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from KListView.

virtual void KFileTreeView::contentsDragLeaveEvent (  QDragLeaveEvent *    e )  [protected, virtual]
 

Reimplemented for internal reasons. Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from KListView.

virtual void KFileTreeView::contentsDragMoveEvent (  QDragMoveEvent *    e )  [protected, virtual]
 

Reimplemented for internal reasons. Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from KListView.

virtual void KFileTreeView::contentsDropEvent (  QDropEvent *    ev )  [protected, virtual]
 

Reimplemented for internal reasons. Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from KListView.

KFileTreeViewItem* KFileTreeView::currentKFileTreeViewItem (    ) 
 

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

KURL KFileTreeView::currentURL (    ) 
 

Returns:
the URL of the current selected item.

virtual QDragObject* KFileTreeView::dragObject (    )  [protected, virtual]
 

Returns:
a dragobject encoding the current selection.
See also:
setDragEnabled()

Reimplemented from KListView.

void KFileTreeView::dropped (  QDropEvent *   ,
QListViewItem *   ,
QListViewItem *   
)  [signal]
 

This signal gets emitted whenever something acceptable is dropped onto the listview.

This function also provides a parent, in the event that your listview is a tree

Parameters:
e  is the drop event itself (it has already been accepted)
parent  the item that is to be the parent of the new item
after  is the item after which the drop occured (or 0L, if the drop was above all items

Reimplemented from KListView.

void KFileTreeView::dropped (  QDropEvent *   ,
QListViewItem *   
)  [signal]
 

This signal gets emitted whenever something acceptable is dropped onto the listview.

Parameters:
e  is the drop event itself (it has already been accepted)
after  is the item after which the drop occured (or 0L, if the drop was above all items)
See also:
acceptDrop()

Reimplemented from KListView.

KFileTreeViewItem* KFileTreeView::findItem (  const QString &    branchName,
const QString &    relUrl
) 
 

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

KFileTreeViewItem* KFileTreeView::findItem (  KFileTreeBranch *    brnch,
const QString &    relUrl
) 
 

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.

Returns:
a pointer to the item or zero if the item does not exist.
Parameters:
brnch  is a pointer to the branch to search in
relUrl  is the branch relativ url

virtual bool KFileTreeView::removeBranch (  KFileTreeBranch *    branch )  [virtual]
 

removes the branch from the treeview.

Parameters:
branch  is a pointer to the branch
Returns:
true on success.

virtual void KFileTreeView::setDirOnlyMode (  KFileTreeBranch *    brnch,
bool   
)  [virtual]
 

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

Parameters:
branch  is a pointer to a KFileTreeBranch

virtual void KFileTreeView::setShowFolderOpenPixmap (  bool    showIt = true )  [inline, 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

Definition at line 163 of file kfiletreeview.h.

bool KFileTreeView::showFolderOpenPixmap (    )  const [inline]
 

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

Definition at line 152 of file kfiletreeview.h.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:13 2003 for kdelibs by doxygen1.2.18