KFileDetailView Class Reference

#include <tdefiledetailview.h>

Inheritance diagram for KFileDetailView:

Signals
void	dropped (TQDropEvent *event, KFileItem *fileItem)
void	dropped (TQDropEvent *event, const KURL::List &urls, const KURL &url)

Public Member Functions
	KFileDetailView (TQWidget *parent, const char *name)
virtual TQWidget *	widget ()
virtual void	clearView ()
virtual void	setAutoUpdate (bool)
virtual void	setSelectionMode (KFile::SelectionMode sm)
virtual void	updateView (bool)
virtual void	updateView (const KFileItem *)
virtual void	removeItem (const KFileItem *)
virtual void	listingCompleted ()
virtual void	setSelected (const KFileItem *, bool)
virtual bool	isSelected (const KFileItem *i) const
virtual void	clearSelection ()
virtual void	selectAll ()
virtual void	invertSelection ()
virtual void	setCurrentItem (const KFileItem *)
virtual KFileItem *	currentFileItem () const
virtual KFileItem *	firstFileItem () const
virtual KFileItem *	nextItem (const KFileItem *) const
virtual KFileItem *	prevItem (const KFileItem *) const
virtual void	insertItem (KFileItem *i)
virtual void	setSorting (TQDir::SortSpec)
void	ensureItemVisible (const KFileItem *)
void	mimeTypeDeterminationFinished ()
void	determineIcon (KFileListViewItem *item)
TQScrollView *	scrollWidget () const
virtual void	readConfig (TDEConfig *, const TQString &group=TQString::null)
virtual void	writeConfig (TDEConfig *, const TQString &group=TQString::null)
Public Member Functions inherited from KFileView
virtual	~KFileView ()
void	addItemList (const KFileItemList &list)
virtual TQWidget *	widget ()=0
TQWidget *	widget () const
void	setCurrentItem (const TQString &filename)
virtual void	setCurrentItem (const KFileItem *item)=0
virtual KFileItem *	currentFileItem () const =0
virtual void	clear ()
virtual void	updateView (bool f=true)
virtual void	updateView (const KFileItem *)
virtual void	removeItem (const KFileItem *item)
virtual void	listingCompleted ()
TQDir::SortSpec	sorting () const
virtual void	setSorting (TQDir::SortSpec sort)
bool	isReversed () const
void	sortReversed ()
uint	count () const
uint	numFiles () const
uint	numDirs () const
virtual void	setSelectionMode (KFile::SelectionMode sm)
virtual KFile::SelectionMode	selectionMode () const
virtual void	setViewMode (ViewMode vm)
virtual ViewMode	viewMode () const
TQString	viewName () const
void	setViewName (const TQString &name)
virtual void	setParentView (KFileView *parent)
virtual void	insertItem (KFileItem *i)
virtual void	clearView ()=0
virtual void	ensureItemVisible (const KFileItem *i)=0
virtual void	clearSelection ()=0
virtual void	selectAll ()
virtual void	invertSelection ()
virtual void	setSelected (const KFileItem *, bool enable)=0
virtual bool	isSelected (const KFileItem *) const =0
const KFileItemList *	selectedItems () const
const KFileItemList *	items () const
virtual KFileItem *	firstFileItem () const =0
virtual KFileItem *	nextItem (const KFileItem *) const =0
virtual KFileItem *	prevItem (const KFileItem *) const =0
void	setOnlyDoubleClickSelectsFiles (bool enable)
bool	onlyDoubleClickSelectsFiles () const
bool	updateNumbers (const KFileItem *i)
virtual TDEActionCollection *	actionCollection () const
KFileViewSignaler *	signaler () const
virtual void	readConfig (TDEConfig *, const TQString &group=TQString::null)
virtual void	writeConfig (TDEConfig *, const TQString &group=TQString::null)
void	setDropOptions (int options)
int	dropOptions ()

Protected Slots
void	slotSelectionChanged ()

Protected Member Functions
virtual void	keyPressEvent (TQKeyEvent *)
virtual TQDragObject *	dragObject ()
virtual void	contentsDragEnterEvent (TQDragEnterEvent *e)
virtual void	contentsDragMoveEvent (TQDragMoveEvent *e)
virtual void	contentsDragLeaveEvent (TQDragLeaveEvent *e)
virtual void	contentsDropEvent (TQDropEvent *ev)
virtual bool	acceptDrag (TQDropEvent *e) const
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from KFileView
virtual void	virtual_hook (int id, void *data)
void	setDropOptions_impl (int options)

Protected Attributes
int	m_sortingCol
Protected Attributes inherited from KFileView
KFileViewSignaler *	sig

Additional Inherited Members
Public Types inherited from KFileView
enum	ViewMode { Files = 1 , Directories = 2 , All = Files | Directories }
enum	DropOptions { AutoOpenDirs = 1 }
Static Public Member Functions inherited from KFileView
static TQString	sortingKey (const TQString &value, bool isDir, int sortSpec)
static TQString	sortingKey (TDEIO::filesize_t value, bool isDir, int sortSpec)
static int	autoOpenDelay ()
Protected Types inherited from KFileView
enum	{ VIRTUAL_SET_DROP_OPTIONS = 1 }

Detailed Description

A list-view capable of showing KFileItem'.

Used in the filedialog for example. Most of the documentation is in KFileView class.

See also

KDirOperator

KCombiView

KFileIconView

Definition at line 108 of file tdefiledetailview.h.

Constructor & Destructor Documentation

KFileDetailView()

KFileDetailView::KFileDetailView	(	TQWidget *	parent,
		const char *	name
	)

Definition at line 57 of file tdefiledetailview.cpp.

~KFileDetailView()

KFileDetailView::~KFileDetailView ( )

virtual

Definition at line 126 of file tdefiledetailview.cpp.

Member Function Documentation

acceptDrag()

bool KFileDetailView::acceptDrag ( TQDropEvent *  e ) const

protectedvirtual

Definition at line 574 of file tdefiledetailview.cpp.

clearSelection()

void KFileDetailView::clearSelection ( )

virtual

Clears any selection, unhighlights everything.

Must be implemented by the view.

Implements KFileView.

Definition at line 172 of file tdefiledetailview.cpp.

clearView()

void KFileDetailView::clearView ( )

virtual

pure virtual function, that should be implemented to clear the view.

At this moment the list is already empty

Implements KFileView.

Definition at line 201 of file tdefiledetailview.cpp.

contentsDragEnterEvent()

void KFileDetailView::contentsDragEnterEvent ( TQDragEnterEvent *  e )

protectedvirtual

Definition at line 583 of file tdefiledetailview.cpp.

contentsDragLeaveEvent()

void KFileDetailView::contentsDragLeaveEvent ( TQDragLeaveEvent *  e )

protectedvirtual

Definition at line 632 of file tdefiledetailview.cpp.

contentsDragMoveEvent()

void KFileDetailView::contentsDragMoveEvent ( TQDragMoveEvent *  e )

protectedvirtual

Definition at line 606 of file tdefiledetailview.cpp.

contentsDropEvent()

void KFileDetailView::contentsDropEvent ( TQDropEvent *  ev )

protectedvirtual

Definition at line 638 of file tdefiledetailview.cpp.

currentFileItem()

KFileItem * KFileDetailView::currentFileItem ( ) const

virtual

Returns

the "current" KFileItem, e.g. where the cursor is. Returns 0L when there is no current item (e.g. in an empty view). Subclasses have to implement this.

Implements KFileView.

Definition at line 163 of file tdefiledetailview.cpp.

determineIcon()

void KFileDetailView::determineIcon

(

KFileListViewItem *

item

)

Definition at line 524 of file tdefiledetailview.cpp.

dragObject()

TQDragObject * KFileDetailView::dragObject ( )

protectedvirtual

Definition at line 535 of file tdefiledetailview.cpp.

dropped [1/2]

void KFileDetailView::dropped ( TQDropEvent *  event, const KURL::List &  urls, const KURL &  url  )

signal

The user dropped the URLs urls.

url points to the item dropped on or can be empty if the user dropped on empty space.

Since

3.2

dropped [2/2]

void KFileDetailView::dropped ( TQDropEvent *  event, KFileItem *  fileItem  )

signal

The user dropped something.

fileItem points to the item dropped on or can be 0 if the user dropped on empty space.

Since

3.2

ensureItemVisible()

void KFileDetailView::ensureItemVisible ( const KFileItem *  i )

virtual

pure virtual function, that should be implemented to make item i visible, i.e.

by scrolling the view appropriately.

Implements KFileView.

Definition at line 453 of file tdefiledetailview.cpp.

firstFileItem()

KFileItem * KFileDetailView::firstFileItem ( ) const

virtual

Implements KFileView.

Definition at line 470 of file tdefiledetailview.cpp.

insertItem()

void KFileDetailView::insertItem ( KFileItem *  i )

virtual

The derived view must implement this function to add the file in the widget.

Make sure to call this implementation, i.e. KFileView::insertItem( i );

Reimplemented from KFileView.

Definition at line 207 of file tdefiledetailview.cpp.

invertSelection()

void KFileDetailView::invertSelection ( )

virtual

Inverts the current selection, i.e.

selects all items, that were up to now not selected and deselects the other.

Reimplemented from KFileView.

Definition at line 186 of file tdefiledetailview.cpp.

isSelected()

bool KFileDetailView::isSelected ( const KFileItem *  ) const

virtual

Returns

whether the given item is currently selected. Must be implemented by the view.

Implements KFileView.

Definition at line 285 of file tdefiledetailview.cpp.

keyPressEvent()

void KFileDetailView::keyPressEvent ( TQKeyEvent *  e )

protectedvirtual

Definition at line 504 of file tdefiledetailview.cpp.

listingCompleted()

void KFileDetailView::listingCompleted ( )

virtual

This hook is called when all items of the currently listed directory are listed and inserted into the view, i.e.

there won't come any new items anymore.

Reimplemented from KFileView.

Definition at line 530 of file tdefiledetailview.cpp.

mimeTypeDeterminationFinished()

void KFileDetailView::mimeTypeDeterminationFinished

(

)

Definition at line 519 of file tdefiledetailview.cpp.

nextItem()

KFileItem * KFileDetailView::nextItem ( const KFileItem *  fileItem ) const

virtual

Implements KFileView.

Definition at line 478 of file tdefiledetailview.cpp.

prevItem()

KFileItem * KFileDetailView::prevItem ( const KFileItem *  fileItem ) const

virtual

Implements KFileView.

Definition at line 491 of file tdefiledetailview.cpp.

readConfig()

void KFileDetailView::readConfig ( TDEConfig *  config, const TQString &  group = TQString::null  )

virtual

Reimplemented from KFileView.

Definition at line 132 of file tdefiledetailview.cpp.

removeItem()

void KFileDetailView::removeItem ( const KFileItem *  item )

virtual

Removes an item from the list; has to be implemented by the view.

Call KFileView::removeItem( item ) after removing it.

Reimplemented from KFileView.

Definition at line 339 of file tdefiledetailview.cpp.

scrollWidget()

TQScrollView * KFileDetailView::scrollWidget ( ) const

inline

Definition at line 149 of file tdefiledetailview.h.

selectAll()

void KFileDetailView::selectAll ( )

virtual

Selects all items.

You may want to override this, if you can implement it more efficiently than calling setSelected() with every item. This works only in Multiselection mode of course.

Reimplemented from KFileView.

Definition at line 177 of file tdefiledetailview.cpp.

setAutoUpdate()

virtual void KFileDetailView::setAutoUpdate ( bool  )

inlinevirtual

Definition at line 118 of file tdefiledetailview.h.

setCurrentItem()

void KFileDetailView::setCurrentItem ( const KFileItem *  item )

virtual

Reimplement this to set item the current item in the view, e.g.

the item having focus.

Implements KFileView.

Definition at line 154 of file tdefiledetailview.cpp.

setSelected()

void KFileDetailView::setSelected ( const KFileItem *  , bool  enable  )

virtual

Tells the view that it should highlight the item.

This function must be implemented by the view.

Implements KFileView.

Definition at line 142 of file tdefiledetailview.cpp.

setSelectionMode()

void KFileDetailView::setSelectionMode ( KFile::SelectionMode  sm )

virtual

Reimplemented from KFileView.

Definition at line 254 of file tdefiledetailview.cpp.

setSorting()

void KFileDetailView::setSorting ( TQDir::SortSpec  sort )

virtual

Sets the sorting order of the view.

Default is TQDir::Name | TQDir::IgnoreCase | TQDir::DirsFirst Override this in your subclass and sort accordingly (usually by setting the sorting-key for every item and telling QIconView or TQListView to sort.

A view may choose to use a different sorting than TQDir::Name, Time or Size. E.g. to sort by mimetype or any possible string. Set the sorting to TQDir::Unsorted for that and do the rest internally.

See also

sortingKey

Reimplemented from KFileView.

Definition at line 425 of file tdefiledetailview.cpp.

slotSelectionChanged

void KFileDetailView::slotSelectionChanged ( )

protectedslot

Definition at line 465 of file tdefiledetailview.cpp.

updateView() [1/2]

void KFileDetailView::updateView ( bool  f )

virtual

does a repaint of the view.

The default implementation calls

widget()->repaint(f)

Reimplemented from KFileView.

Definition at line 295 of file tdefiledetailview.cpp.

updateView() [2/2]

void KFileDetailView::updateView ( const KFileItem *  i )

virtual

Reimplemented from KFileView.

Definition at line 307 of file tdefiledetailview.cpp.

virtual_hook()

void KFileDetailView::virtual_hook ( int  id, void *  data  )

protectedvirtual

Reimplemented from KFileView.

Definition at line 681 of file tdefiledetailview.cpp.

widget()

virtual TQWidget * KFileDetailView::widget ( )

inlinevirtual

a pure virtual function to get a TQWidget, that can be added to other widgets.

This function is needed to make it possible for derived classes to derive from other widgets.

Implements KFileView.

Definition at line 116 of file tdefiledetailview.h.

writeConfig()

void KFileDetailView::writeConfig ( TDEConfig *  config, const TQString &  group = TQString::null  )

virtual

Reimplemented from KFileView.

Definition at line 137 of file tdefiledetailview.cpp.

Member Data Documentation

m_sortingCol

int KFileDetailView::m_sortingCol

protected

Definition at line 181 of file tdefiledetailview.h.

---

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

• tdefiledetailview.h
• tdefiledetailview.cpp