FileTreeViewWidgetImpl Class Reference

#include <filetreeviewwidgetimpl.h>

Inheritance diagram for FileTreeViewWidgetImpl:

[legend]Collaboration diagram for FileTreeViewWidgetImpl:


Signals
void	implementationInvalidated ()
	Emitted when the current implementation "recognizes" it cannot work anymore: for example the VCS impl.
Public Member Functions
	FileTreeViewWidgetImpl (FileTreeWidget parent, const char name)
virtual	~FileTreeViewWidgetImpl ()
KURL::List	selectedPathUrls ()
	return a list containing the filenames of the currently selected items.
FileTreeWidget *	fileTree () const
QDomDocument &	projectDom () const
QHeader *	header () const
void	setColumnWidth (int column, int w)
int	contentsWidth () const
void	triggerUpdate ()
FileViewPart *	part () const
filetreeview::FileTreeViewItem *	currentItem () const
filetreeview::BranchItemFactory *	branchItemFactory () const
virtual bool	canReloadTree () const =0
	Costraints that must be satisfied to start a reload of the the tree.
virtual void	fillPopupMenu (QPopupMenu popupMenu, QListViewItem item) const
	Here the popup menu is filled: by standard only the "reload tree" (only if the above function returns true) and "show project files" options are added.
bool	showNonProjectFiles () const
Protected Member Functions
void	setBranchItemFactory (filetreeview::BranchItemFactory *aFactory)
QString	projectDirectory () const
Private Slots
void	slotReloadTree ()
void	slotToggleShowNonProjectFiles ()
Private Member Functions
QValueList< QListViewItem * >	allSelectedItems (QListViewItem *item) const
Private Attributes
filetreeview::BranchItemFactory *	m_branchItemFactory
FileViewPart *	m_part
bool	m_isReloadingTree
KToggleAction *	m_actionToggleShowNonProjectFiles

Detailed Description

Author:: Mario Scalas A base class for providing additional features to the standard KFileTreeViewItem-based widget we use for listing files in project directory.

Definition at line 39 of file filetreeviewwidgetimpl.h.

Constructor & Destructor Documentation

FileTreeViewWidgetImpl::FileTreeViewWidgetImpl ( FileTreeWidget * parent,

const char * name

)

Definition at line 32 of file filetreeviewwidgetimpl.cpp.
References kdDebug(), m_actionToggleShowNonProjectFiles, m_part, KDevPlugin::projectDom(), KToggleAction::setChecked(), KToggleAction::setCheckedState(), KAction::setWhatsThis(), and slotToggleShowNonProjectFiles().

FileTreeViewWidgetImpl::~FileTreeViewWidgetImpl ( ) [virtual]

Definition at line 53 of file filetreeviewwidgetimpl.cpp.
References kdDebug(), m_part, KDevPlugin::projectDom(), showNonProjectFiles(), and DomUtil::writeBoolEntry().

Member Function Documentation

QValueList< QListViewItem * > FileTreeViewWidgetImpl::allSelectedItems ( QListViewItem * item ) const [private]

Definition at line 130 of file filetreeviewwidgetimpl.cpp.
Referenced by selectedPathUrls().

filetreeview::BranchItemFactory* FileTreeViewWidgetImpl::branchItemFactory ( ) const [inline]

Returns:
a reference to a new filetreeview::BranchItemFactory object which can be used for filling the tree view.

Definition at line 61 of file filetreeviewwidgetimpl.h.

virtual bool FileTreeViewWidgetImpl::canReloadTree ( ) const [pure virtual]

Costraints that must be satisfied to start a reload of the the tree.

Returns:

Implemented in StdFileTreeWidgetImpl, and VCSFileTreeWidgetImpl.
Referenced by fillPopupMenu().

int FileTreeViewWidgetImpl::contentsWidth ( ) const [inline]

Definition at line 53 of file filetreeviewwidgetimpl.h.
References fileTree().
Referenced by VCSFileTreeWidgetImpl::slotToggleShowVCSFields().

filetreeview::FileTreeViewItem* FileTreeViewWidgetImpl::currentItem ( ) const [inline]

Definition at line 56 of file filetreeviewwidgetimpl.h.
References fileTree().

FileTreeWidget * FileTreeViewWidgetImpl::fileTree ( ) const

Definition at line 65 of file filetreeviewwidgetimpl.cpp.
Referenced by contentsWidth(), currentItem(), fillPopupMenu(), header(), selectedPathUrls(), setColumnWidth(), slotReloadTree(), slotToggleShowNonProjectFiles(), and triggerUpdate().

void FileTreeViewWidgetImpl::fillPopupMenu ( QPopupMenu * popupMenu,

QListViewItem * item

) const [virtual]

Here the popup menu is filled: by standard only the "reload tree" (only if the above function returns true) and "show project files" options are added.

Parameters:

popupMenu the menu to fill

item the QListViewItem which this menu has been requested upon

Reimplemented in VCSFileTreeWidgetImpl.
Definition at line 93 of file filetreeviewwidgetimpl.cpp.
References canReloadTree(), fileTree(), m_actionToggleShowNonProjectFiles, KToggleAction::plug(), and slotReloadTree().
Referenced by VCSFileTreeWidgetImpl::fillPopupMenu().

QHeader* FileTreeViewWidgetImpl::header ( ) const [inline]

Definition at line 51 of file filetreeviewwidgetimpl.h.
References fileTree().
Referenced by VCSFileTreeWidgetImpl::slotToggleShowVCSFields(), and StdFileTreeWidgetImpl::StdFileTreeWidgetImpl().

void FileTreeViewWidgetImpl::implementationInvalidated ( ) [signal]

Emitted when the current implementation "recognizes" it cannot work anymore: for example the VCS impl.
can ask to be relieved from work when the VCS plug-in it uses has been unloaded!
Referenced by VCSFileTreeWidgetImpl::VCSFileTreeWidgetImpl().

FileViewPart* FileTreeViewWidgetImpl::part ( ) const [inline]

Definition at line 55 of file filetreeviewwidgetimpl.h.
Referenced by projectDirectory(), and projectDom().

QString FileTreeViewWidgetImpl::projectDirectory ( ) const [protected]

Definition at line 79 of file filetreeviewwidgetimpl.cpp.
References part(), KDevPlugin::project(), and KDevProject::projectDirectory().
Referenced by slotReloadTree(), and VCSFileTreeWidgetImpl::slotSyncWithRepository().

QDomDocument & FileTreeViewWidgetImpl::projectDom ( ) const

Definition at line 72 of file filetreeviewwidgetimpl.cpp.
References part(), and KDevPlugin::projectDom().
Referenced by VCSFileTreeWidgetImpl::VCSFileTreeWidgetImpl(), and VCSFileTreeWidgetImpl::~VCSFileTreeWidgetImpl().

KURL::List FileTreeViewWidgetImpl::selectedPathUrls ( )

return a list containing the filenames of the currently selected items.

Definition at line 109 of file filetreeviewwidgetimpl.cpp.
References allSelectedItems(), fileTree(), kdDebug(), and KURL::setPath().

void FileTreeViewWidgetImpl::setBranchItemFactory ( filetreeview::BranchItemFactory * aFactory ) [inline, protected]

Definition at line 91 of file filetreeviewwidgetimpl.h.
References m_branchItemFactory.
Referenced by StdFileTreeWidgetImpl::StdFileTreeWidgetImpl(), and VCSFileTreeWidgetImpl::VCSFileTreeWidgetImpl().

void FileTreeViewWidgetImpl::setColumnWidth ( int column,

int w

) [inline]

Definition at line 52 of file filetreeviewwidgetimpl.h.
References fileTree().
Referenced by VCSFileTreeWidgetImpl::slotToggleShowVCSFields().

bool FileTreeViewWidgetImpl::showNonProjectFiles ( ) const

Returns:
true if non project files are to be shown, false otherwise

Definition at line 86 of file filetreeviewwidgetimpl.cpp.
References KToggleAction::isChecked(), and m_actionToggleShowNonProjectFiles.
Referenced by ~FileTreeViewWidgetImpl().

void FileTreeViewWidgetImpl::slotReloadTree ( ) [private, slot]

Definition at line 154 of file filetreeviewwidgetimpl.cpp.
References fileTree(), FileTreeWidget::openDirectory(), and projectDirectory().
Referenced by fillPopupMenu().

void FileTreeViewWidgetImpl::slotToggleShowNonProjectFiles ( ) [private, slot]

Definition at line 161 of file filetreeviewwidgetimpl.cpp.
References fileTree(), and FileTreeWidget::hideOrShow().
Referenced by FileTreeViewWidgetImpl().