KFilePreview Class Reference

#include <tdefilepreview.h>

Inheritance diagram for KFilePreview:

Signals
void	showPreview (const KURL &)
void	clearPreview ()

Public Member Functions
	KFilePreview (TQWidget *parent, const char *name)
	KFilePreview (KFileView *view, TQWidget *parent, const char *name)
virtual TQWidget *	widget ()
virtual void	clearView ()
void	setFileView (KFileView *view)
KFileView *	fileView () const
virtual void	updateView (bool)
virtual void	updateView (const KFileItem *)
virtual void	removeItem (const KFileItem *)
virtual void	listingCompleted ()
virtual void	setSelectionMode (KFile::SelectionMode sm)
virtual void	setSelected (const KFileItem *, bool)
virtual bool	isSelected (const KFileItem *) const
virtual void	clearSelection ()
virtual void	selectAll ()
virtual void	invertSelection ()
virtual void	insertItem (KFileItem *)
virtual void	clear ()
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	setSorting (TQDir::SortSpec sort)
virtual void	readConfig (TDEConfig *, const TQString &group=TQString::null)
virtual void	writeConfig (TDEConfig *, const TQString &group=TQString::null)
virtual TDEActionCollection *	actionCollection () const
void	ensureItemVisible (const KFileItem *)
void	setPreviewWidget (const TQWidget *w, const KURL &u)
Public Member Functions inherited from KFileView
virtual	~KFileView ()
void	addItemList (const KFileItemList &list)
TQWidget *	widget () const
void	setCurrentItem (const TQString &filename)
TQDir::SortSpec	sorting () const
bool	isReversed () const
void	sortReversed ()
uint	count () const
uint	numFiles () const
uint	numDirs () const
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)
const KFileItemList *	selectedItems () const
const KFileItemList *	items () const
void	setOnlyDoubleClickSelectsFiles (bool enable)
bool	onlyDoubleClickSelectsFiles () const
bool	updateNumbers (const KFileItem *i)
KFileViewSignaler *	signaler () const
void	setDropOptions (int options)
int	dropOptions ()

Protected Slots
virtual void	slotHighlighted (const KFileItem *)

Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from KFileView
void	setDropOptions_impl (int options)

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 }
Protected Attributes inherited from KFileView
KFileViewSignaler *	sig

Detailed Description

This KFileView is an empbedded preview for some file types.

Definition at line 39 of file tdefilepreview.h.

Member Function Documentation

actionCollection()

TDEActionCollection * KFilePreview::actionCollection ( ) const

virtual

This overrides KFileView::actionCollection() by returning the actionCollection() of the KFileView (member left) it contains.

This means that KFilePreview will never create a TDEActionCollection object of its own.

Reimplemented from KFileView.

Definition at line 257 of file tdefilepreview.cpp.

clear()

void KFilePreview::clear ( )

virtual

Clears the view and all item lists.

Reimplemented from KFileView.

Definition at line 174 of file tdefilepreview.cpp.

clearSelection()

void KFilePreview::clearSelection ( )

virtual

Clears any selection, unhighlights everything.

Must be implemented by the view.

Implements KFileView.

Definition at line 180 of file tdefilepreview.cpp.

clearView()

void KFilePreview::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 142 of file tdefilepreview.cpp.

currentFileItem()

KFileItem * KFilePreview::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 214 of file tdefilepreview.cpp.

ensureItemVisible()

void KFilePreview::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 237 of file tdefilepreview.cpp.

fileView()

KFileView* KFilePreview::fileView ( ) const

inline

Returns

the current fileview

Definition at line 60 of file tdefilepreview.h.

insertItem()

void KFilePreview::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 130 of file tdefilepreview.cpp.

invertSelection()

void KFilePreview::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 191 of file tdefilepreview.cpp.

isSelected()

bool KFilePreview::isSelected ( const KFileItem *  ) const

virtual

Returns

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

Implements KFileView.

Definition at line 196 of file tdefilepreview.cpp.

listingCompleted()

void KFilePreview::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 169 of file tdefilepreview.cpp.

removeItem()

void KFilePreview::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 160 of file tdefilepreview.cpp.

selectAll()

void KFilePreview::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 186 of file tdefilepreview.cpp.

setCurrentItem()

void KFilePreview::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 209 of file tdefilepreview.cpp.

setFileView()

void KFilePreview::setFileView

(

KFileView *

view

)

Delets the current view and sets the view to the given view.

The view is reparented to have this as parent, if necessary.

Definition at line 81 of file tdefilepreview.cpp.

setSelected()

void KFilePreview::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 205 of file tdefilepreview.cpp.

setSorting()

void KFilePreview::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 136 of file tdefilepreview.cpp.

updateView()

void KFilePreview::updateView ( bool  f )

virtual

does a repaint of the view.

The default implementation calls

widget()->repaint(f)

Reimplemented from KFileView.

Definition at line 148 of file tdefilepreview.cpp.

widget()

virtual TQWidget* KFilePreview::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 48 of file tdefilepreview.h.

---

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

• tdefilepreview.h
• tdefilepreview.cpp