# kio Library API Documentation

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

# KFileTreeBranch Class Reference

This is the branch class of the KFileTreeView, which represents one branch in the treeview. Branch object for KFileTreeView object. More...

`#include <kfiletreebranch.h>`

Inheritance diagram for KFileTreeBranch:

[legend]
Collaboration diagram for KFileTreeBranch:

[legend]
List of all members.

## Public Slots

virtual bool | populate (const KURL &url, KFileTreeViewItem *currItem)
virtual void | setShowExtensions (bool visible=true)
void | setOpenPixmap (const QPixmap &pix)

## Signals

void | populateFinished (KFileTreeViewItem *)
void | newTreeViewItems (KFileTreeBranch *, const KFileTreeViewItemList &)
void | directoryChildCount (KFileTreeViewItem *item, int count)

## Public Member Functions

| KFileTreeBranch (KFileTreeView *, const KURL &url, const QString &name, const QPixmap &pix, bool showHidden=false, KFileTreeViewItem *branchRoot=0)
KURL | rootUrl () const
virtual void | setRoot (KFileTreeViewItem *r)
KFileTreeViewItem * | root ()
QString | name () const
virtual void | setName (const QString n)
const QPixmap & | pixmap ()
const QPixmap & | openPixmap ()
bool | showExtensions () const
void | setOpen (bool setopen=true)
void | setChildRecurse (bool t=true)
bool | childRecurse ()
virtual KFileTreeViewItem * | findTVIByURL (const KURL &)

## Protected Member Functions

virtual KFileTreeViewItem * | createTreeViewItem (KFileTreeViewItem *parent, KFileItem *fileItem)
virtual void | virtual_hook (int id, void *data)

## Detailed Description

This is the branch class of the KFileTreeView, which represents one branch in the treeview. Branch object for KFileTreeView object.

Every branch has a root which is an url. The branch lists the files under the root. Every branch uses its own dirlister and can have its own filter etc.

Definition at line 48 of file kfiletreebranch.h.

## Constructor & Destructor Documentation

KFileTreeBranch::KFileTreeBranch | ( | KFileTreeView * | ,
|  | const KURL & | url,
|  | const QString & | name,
|  | const QPixmap & | pix,
|  | bool | showHidden = `false`,
|  | KFileTreeViewItem * | branchRoot = `0`
| ) |

constructs a branch for KFileTreeView.

Does not yet start to list it.

Parameters:

  | url | start url of the branch.
  | name | the name of the branch, which is displayed in the first column of the treeview.
  | pix | is a pixmap to display as an icon of the branch.
  | showHidden | flag to make hidden files visible or not.
  | branchRoot | is the KFileTreeViewItem to use as the root of the branch, with the default 0 meaning to let KFileTreeBranch create it for you.

Definition at line 36 of file kfiletreebranch.cpp.

References QValueList::append(), KDirLister::canceled(), KDirLister::clear(), KDirLister::completed(), QObject::connect(), KDirLister::deleteItem(), endl(), kdDebug(), name(), KDirLister::newItems(), KURL::prettyURL(), KDirLister::redirection(), KDirLister::refreshItems(), QListViewItem::setExpandable(), QListViewItem::setPixmap(), KDirLister::setShowingDotFiles(), QListViewItem::setText(), and KDirLister::started().

## Member Function Documentation

KURL KFileTreeBranch::rootUrl | ( |  | ) | const`[inline]`

Returns:
  the root url of the branch.

Definition at line 69 of file kfiletreebranch.h.

virtual void KFileTreeBranch::setRoot | ( | KFileTreeViewItem * | r | ) | `[inline, virtual]`

sets a KFileTreeViewItem as root widget for the branch.

That must be created outside of the branch. All KFileTreeViewItems the branch is allocating will become children of that object.

Parameters:

  | r | the KFileTreeViewItem to become the root item.

Definition at line 77 of file kfiletreebranch.h.

KFileTreeViewItem* KFileTreeBranch::root | ( |  | ) | `[inline]`

Returns:
  the root item.

Definition at line 82 of file kfiletreebranch.h.

Referenced by KFileTreeView::removeBranch().

QString KFileTreeBranch::name | ( |  | ) | const`[inline]`

Returns:
  the name of the branch.

Reimplemented from QObject.

Definition at line 87 of file kfiletreebranch.h.

Referenced by KFileTreeView::branch(), and KFileTreeBranch().

virtual void KFileTreeBranch::setName | ( | const QString | n | ) | `[inline, virtual]`

| sets the name of the branch. Definition at line 92 of file kfiletreebranch.h.

bool KFileTreeBranch::showExtensions | ( |  | ) | const

Returns:
  whether the items in the branch show their file extensions in the tree or not. See setShowExtensions for more information.

Definition at line 269 of file kfiletreebranch.cpp.

void KFileTreeBranch::setOpen | ( | bool | setopen = `true` | ) | `[inline]`

| sets the root of the branch open or closed. Definition at line 120 of file kfiletreebranch.h.

void KFileTreeBranch::setChildRecurse | ( | bool | t = `true` | ) |

sets if children recursion is wanted or not.

If this is switched off, the child directories of a just opened directory are not listed internally. That means that it can not be determined if the sub directories are expandable or not. If this is switched off there will be no call to setExpandable.

Parameters:

  | t | set to true to switch on child recursion

Definition at line 256 of file kfiletreebranch.cpp.

References QValueList::clear().

bool KFileTreeBranch::childRecurse | ( |  | ) | `[inline]`

Returns:
  if child recursion is on or off.

See also:
  setChildRecurse

Definition at line 137 of file kfiletreebranch.h.

bool KFileTreeBranch::populate | ( | const KURL & | url,
|  | KFileTreeViewItem * | currItem
| ) | `[virtual, slot]`

populates a branch.

This method must be called after a branch was added to a KFileTreeView using method addBranch.

Parameters:

  | url | is the url of the root item where the branch starts.
  | currItem | is the current parent.

Definition at line 495 of file kfiletreebranch.cpp.

References QValueList::append(), endl(), kdDebug(), KDirLister::openURL(), and KURL::prettyURL().

void KFileTreeBranch::setShowExtensions | ( | bool | visible = `true` | ) | `[virtual, slot]`

sets printing of the file extensions on or off.

If you pass false to this slot, all items of this branch will not show their file extensions in the tree.

Parameters:

  | visible | flags if the extensions should be visible or not.

Definition at line 264 of file kfiletreebranch.cpp.

KFileTreeViewItem * KFileTreeBranch::createTreeViewItem | ( | KFileTreeViewItem * | parent,
|  | KFileItem * | fileItem
| ) | `[protected, virtual]`

| allocates a KFileTreeViewItem for the branch for new items. Definition at line 239 of file kfiletreebranch.cpp. References endl(), and kdDebug().

KFileTreeViewItem * KFileTreeBranch::findTVIByURL | ( | const KURL & |  | ) | `[virtual]`

| find the according KFileTreeViewItem by an url Definition at line 368 of file kfiletreebranch.cpp. References endl(), KURL::equals(), KFileItem::extraData(), KDirLister::findByURL(), kdDebug(), and KURL::url().

void KFileTreeBranch::populateFinished | ( | KFileTreeViewItem * |  | ) | `[signal]`

| emitted with the item of a directory which was finished to populate

void KFileTreeBranch::newTreeViewItems | ( | KFileTreeBranch * | ,
|  | const KFileTreeViewItemList & |
| ) | `[signal]`

| emitted with a list of new or updated KFileTreeViewItem which were found in a branch. Note that this signal is emitted very often and may slow down the performance of the treeview !

void KFileTreeBranch::directoryChildCount | ( | KFileTreeViewItem * | item,
|  | int | count
| ) | `[signal]`

| emitted with the exact count of children for a directory.

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

- kfiletreebranch.h
- kfiletreebranch.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:48 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003