KFileTreeBranch Class Reference

#include <tdefiletreebranch.h>

Inherits KDirLister.

Public Slots
virtual bool	populate (const KURL &url, KFileTreeViewItem *currItem)
virtual void	setShowExtensions (bool visible=true)
void	setOpenPixmap (const TQPixmap &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 TQString &name, const TQPixmap &pix, bool showHidden=false, KFileTreeViewItem *branchRoot=0)
KURL	rootUrl () const
virtual void	setRoot (KFileTreeViewItem *r)
KFileTreeViewItem *	root ()
TQString	name () const
virtual void	setName (const TQString n)
const TQPixmap &	pixmap ()
const TQPixmap &	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.

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.

Branch object for KFileTreeView object.

Definition at line 48 of file tdefiletreebranch.h.

Constructor & Destructor Documentation

KFileTreeBranch()

KFileTreeBranch::KFileTreeBranch	(	KFileTreeView *	parent,
		const KURL &	url,
		const TQString &	name,
		const TQPixmap &	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 tdefiletreebranch.cpp.

Member Function Documentation

childRecurse()

bool KFileTreeBranch::childRecurse ( )

inline

Returns

if child recursion is on or off.

See also

setChildRecurse

Definition at line 137 of file tdefiletreebranch.h.

createTreeViewItem()

KFileTreeViewItem * KFileTreeBranch::createTreeViewItem ( KFileTreeViewItem *  parent, KFileItem *  fileItem  )

protectedvirtual

allocates a KFileTreeViewItem for the branch for new items.

Definition at line 239 of file tdefiletreebranch.cpp.

directoryChildCount

void KFileTreeBranch::directoryChildCount ( KFileTreeViewItem *  item, int  count  )

signal

emitted with the exact count of children for a directory.

findTVIByURL()

KFileTreeViewItem * KFileTreeBranch::findTVIByURL ( const KURL &  url )

virtual

find the according KFileTreeViewItem by an url

Definition at line 368 of file tdefiletreebranch.cpp.

name()

TQString KFileTreeBranch::name ( ) const

inline

Returns

the name of the branch.

Definition at line 87 of file tdefiletreebranch.h.

newTreeViewItems

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 !

populate

bool KFileTreeBranch::populate ( const KURL &  url, KFileTreeViewItem *  currItem  )

virtualslot

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 tdefiletreebranch.cpp.

populateFinished

void KFileTreeBranch::populateFinished ( KFileTreeViewItem *  )

signal

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

root()

KFileTreeViewItem* KFileTreeBranch::root ( )

inline

Returns

the root item.

Definition at line 82 of file tdefiletreebranch.h.

rootUrl()

KURL KFileTreeBranch::rootUrl ( ) const

inline

Returns

the root url of the branch.

Definition at line 69 of file tdefiletreebranch.h.

setChildRecurse()

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 tdefiletreebranch.cpp.

setName()

virtual void KFileTreeBranch::setName ( const TQString  n )

inlinevirtual

sets the name of the branch.

Definition at line 92 of file tdefiletreebranch.h.

setOpen()

void KFileTreeBranch::setOpen ( bool  setopen = true )

inline

sets the root of the branch open or closed.

Definition at line 120 of file tdefiletreebranch.h.

setRoot()

virtual void KFileTreeBranch::setRoot ( KFileTreeViewItem *  r )

inlinevirtual

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 tdefiletreebranch.h.

setShowExtensions

void KFileTreeBranch::setShowExtensions ( bool  visible = true )

virtualslot

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 tdefiletreebranch.cpp.

showExtensions()

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 tdefiletreebranch.cpp.

---

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

• tdefiletreebranch.h
• tdefiletreebranch.cpp