#include <kfileitemdelegate.h>

Inherits QAbstractItemDelegate.

Public Types
enum	Information { NoInformation, Size, Permissions, OctalPermissions, Owner, OwnerAndGroup, CreationTime, ModificationTime, AccessTime, MimeType, FriendlyMimeType, LinkDest, LocalPathOrUrl, Comment }

typedef QList< Information >	InformationList

Public Slots
bool	helpEvent (QHelpEvent event, QAbstractItemView view, const QStyleOptionViewItem &option, const QModelIndex &index)

QRegion	shape (const QStyleOptionViewItem &option, const QModelIndex &index)

Public Member Functions
	KFileItemDelegate (QObject *parent=0)

virtual	~KFileItemDelegate ()

virtual QWidget *	createEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const

virtual bool	editorEvent (QEvent event, QAbstractItemModel model, const QStyleOptionViewItem &option, const QModelIndex &index)

virtual bool	eventFilter (QObject object, QEvent event)

QRect	iconRect (const QStyleOptionViewItem &option, const QModelIndex &index) const

bool	jobTransfersVisible () const

QSize	maximumSize () const

virtual void	paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const

virtual void	setEditorData (QWidget *editor, const QModelIndex &index) const

void	setJobTransfersVisible (bool jobTransfersVisible)

void	setMaximumSize (const QSize &size)

virtual void	setModelData (QWidget editor, QAbstractItemModel model, const QModelIndex &index) const

void	setShadowBlur (qreal radius)

void	setShadowColor (const QColor &color)

void	setShadowOffset (const QPointF &offset)

void	setShowInformation (const InformationList &list)

void	setShowInformation (Information information)

void	setShowToolTipWhenElided (bool showToolTip)

void	setWrapMode (QTextOption::WrapMode wrapMode)

qreal	shadowBlur () const

QColor	shadowColor () const

QPointF	shadowOffset () const

InformationList	showInformation () const

bool	showToolTipWhenElided () const

virtual QSize	sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const

virtual void	updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const

QTextOption::WrapMode	wrapMode () const

Properties
InformationList	information

bool	jobTransfersVisible

QSize	maximumSize

qreal	shadowBlur

QColor	shadowColor

QPointF	shadowOffset

bool	showToolTipWhenElided

Detailed Description

KFileItemDelegate is intended to be used to provide a KDE file system view, when using one of the standard item views in Qt with KDirModel.

While primarily intended to be used with KDirModel, it uses Qt::DecorationRole and Qt::DisplayRole for the icons and text labels, just like QItemDelegate, and can thus be used with any standard model.

When used with KDirModel however, KFileItemDelegate can change the way the display and/or decoration roles are drawn, based on properties of the file items. For example, if the file item is a symbolic link, it will use an italic font to draw the file name.

KFileItemDelegate also supports showing additional information about the file items below the icon labels.

Which information should be shown, if any, is controlled by the information property, which is a list that can be set by calling setShowInformation(), and read by calling showInformation(). By default this list is empty.

To use KFileItemDelegate, instantiate an object from the delegate, and call setItemDelegate() in one of the standard item views in Qt:

QListView *listview = new QListView(this);
KFileItemDelegate *delegate = new KFileItemDelegate(this);
listview->setItemDelegate(delegate);

Definition at line 67 of file kfileitemdelegate.h.

Member Typedef Documentation

typedef QList<Information> KFileItemDelegate::InformationList

Definition at line 179 of file kfileitemdelegate.h.

Member Enumeration Documentation

enum KFileItemDelegate::Information

This enum defines the additional information that can be displayed below item labels in icon views.

The information will only be shown for indexes for which the model provides a valid value for KDirModel::FileItemRole, and only when there's sufficient vertical space to display at least one line of the information, along with the display label.

For the number of items to be shown for folders, the model must provide a valid value for KDirMode::ChildCountRole, in addition to KDirModel::FileItemRole.

Note that KFileItemDelegate will not call KFileItem::determineMimeType() if KFileItem::isMimeTypeKnown() returns false, so if you want to display mime types you should use a KMimeTypeResolver with the model and the view, to ensure that mime types are resolved. If the mime type isn't known, "Unknown" will be displayed until the mime type has been successfully resolved.

See also: setShowInformation(); showInformation(); information

Enumerator
NoInformation	No additional information will be shown for items.
Size	The file size for files, and the number of items for folders.
Permissions	A UNIX permissions string, e.g. -rwxr-xr-x.
OctalPermissions	The permissions as an octal value, e.g. 0644.
Owner	The user name of the file owner, e.g. root.
OwnerAndGroup	The user and group that owns the file, e.g. root:root.
CreationTime	The date and time the file/folder was created.
ModificationTime	The date and time the file/folder was last modified.
AccessTime	The date and time the file/folder was last accessed.
MimeType	The mime type for the item, e.g. text/html.
FriendlyMimeType	The descriptive name for the mime type, e.g. HTML Document.
LinkDest	The destination of a symbolic link. Since 4.5
LocalPathOrUrl	The local path to the file or the URL in case it is not a local file. Since 4.5
Comment	A simple comment that can be displayed to the user as is. Since 4.6

Definition at line 162 of file kfileitemdelegate.h.

Constructor & Destructor Documentation

KFileItemDelegate::KFileItemDelegate ( QObject * parent = 0 )

explicit

Constructs a new KFileItemDelegate.

Parameters

parent The parent object for the delegate.

Definition at line 910 of file kfileitemdelegate.cpp.

KFileItemDelegate::~KFileItemDelegate ( )

virtual

Destroys the item delegate.

Definition at line 935 of file kfileitemdelegate.cpp.

Member Function Documentation

QWidget * KFileItemDelegate::createEditor	(	QWidget *	parent,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

virtual

Reimplemented from QAbstractItemDelegate.

Definition at line 1439 of file kfileitemdelegate.cpp.

bool KFileItemDelegate::editorEvent	(	QEvent *	event,
		QAbstractItemModel *	model,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)

virtual

Reimplemented from QAbstractItemDelegate.

Definition at line 1455 of file kfileitemdelegate.cpp.

bool KFileItemDelegate::eventFilter	(	QObject *	object,
		QEvent *	event
	)

virtual

Reimplemented from QAbstractItemDelegate.

Definition at line 1630 of file kfileitemdelegate.cpp.

bool KFileItemDelegate::helpEvent	(	QHelpEvent *	event,
		QAbstractItemView *	view,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)

slot

Reimplemented from QAbstractItemDelegate.

Definition at line 1546 of file kfileitemdelegate.cpp.

QRect KFileItemDelegate::iconRect	(	const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

Returns the rectangle of the icon that is aligned inside the decoration rectangle.

Since: 4.4

Definition at line 1099 of file kfileitemdelegate.cpp.

bool KFileItemDelegate::jobTransfersVisible ( ) const

Returns whether or not the displaying of job transfers is enabled.

See also: setJobTransfersVisible()

Since: 4.5

QSize KFileItemDelegate::maximumSize ( ) const

Returns the maximum size for KFileItemDelegate::sizeHint().

See also: setMaximumSize()

Since: 4.1

void KFileItemDelegate::paint	(	QPainter *	painter,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

virtual

Paints the item indicated by index, using painter.

The item will be drawn in the rectangle specified by option.rect. The correct size for that rectangle can be obtained by calling sizeHint().

This function will use the following data values if the model provides them for the item, in place of the values in option:

Qt::FontRole The font that should be used for the display role.
Qt::AlignmentRole The alignment of the display role.
Qt::ForegroundRole The text color for the display role.
Qt::BackgroundRole The background color for the item.

This function is reimplemented from QAbstractItemDelegate.

Parameters

painter	The painter with which to draw the item.
option	The style options that should be used when painting the item.
index	The index to the item that should be painted.

Definition at line 1245 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setEditorData	(	QWidget *	editor,
		const QModelIndex &	index
	)		const

virtual

Reimplemented from QAbstractItemDelegate.

Definition at line 1467 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setJobTransfersVisible ( bool jobTransfersVisible )

Enable/Disable the displaying of an animated overlay that is shown for any destination urls (in the view).

When enabled, the animations (if any) will be drawn automatically.

Only the files/folders that are visible and have jobs associated with them will display the animation. You would likely not want this enabled if you perform some kind of custom painting that takes up a whole item, and will just make this(and what you paint) look funky.

Default is disabled.

Note: The model (KDirModel) needs to have it's method called with the same value, when you make the call to this method.

Since: 4.5

Definition at line 1107 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setMaximumSize ( const QSize & size )

Sets the maximum size for KFileItemDelegate::sizeHint().

See also: maximumSize()

Since: 4.1

Definition at line 1064 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setModelData	(	QWidget *	editor,
		QAbstractItemModel *	model,
		const QModelIndex &	index
	)		const

virtual

Reimplemented from QAbstractItemDelegate.

Definition at line 1498 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setShadowBlur ( qreal radius )

Sets the blur radius for the text shadow.

See also: shadowBlur()

Definition at line 1052 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setShadowColor ( const QColor & color )

Sets the color used for drawing the text shadow.

To enable text shadows, set the shadow color to a non-transparent color. To disable text shadows, set the color to Qt::transparent.

See also: shadowColor()

Definition at line 1028 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setShadowOffset ( const QPointF & offset )

Sets the horizontal and vertical offset for the text shadow.

See also: shadowOffset()

Definition at line 1040 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setShowInformation ( const InformationList & list )

Sets the list of information lines that are shown below the icon label in list views.

You will typically construct the list like this:

KFileItemDelegate::InformationList list;
list << KFileItemDelegate::FriendlyMimeType << KFileItemDelegate::Size;
delegate->setShowInformation(list);

The information lines will be displayed in the list order. The delegate will first draw the item label, and then as many information lines as will fit in the available space.

Parameters

list	A list of information items that should be shown

Definition at line 1007 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setShowInformation ( Information information )

Sets a single information line that is shown below the icon label in list views.

This is a convenience function for when you only want to show a single line of information.

Parameters

information The information that should be shown

Definition at line 1013 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setShowToolTipWhenElided ( bool showToolTip )

Sets whether a tooltip should be shown if the display role is elided containing the full display role information.

Note: The tooltip will only be shown if the Qt::ToolTipRole differs from Qt::DisplayRole, or if they match, showToolTipWhenElided flag is set and the display role information is elided.

See also: showToolTipWhenElided()

Since: 4.2

Definition at line 1076 of file kfileitemdelegate.cpp.

void KFileItemDelegate::setWrapMode ( QTextOption::WrapMode wrapMode )

When the contents text needs to be wrapped, wrapMode strategy will be followed.

Since: 4.4

Definition at line 1088 of file kfileitemdelegate.cpp.

qreal KFileItemDelegate::shadowBlur ( ) const

Returns the blur radius for the text shadow.

See also: setShadowBlur()

QColor KFileItemDelegate::shadowColor ( ) const

Returns the color used for the text shadow.

See also: setShadowColor()

QPointF KFileItemDelegate::shadowOffset ( ) const

Returns the offset used for the text shadow.

See also: setShadowOffset()

QRegion KFileItemDelegate::shape	(	const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)

slot

Returns the shape of the item as a region.

The returned region can be used for precise hit testing of the item.

Definition at line 1587 of file kfileitemdelegate.cpp.

KFileItemDelegate::InformationList KFileItemDelegate::showInformation ( ) const

Returns the file item information that should be shown below item labels in list views.

Definition at line 1022 of file kfileitemdelegate.cpp.

bool KFileItemDelegate::showToolTipWhenElided ( ) const

Returns whether a tooltip should be shown if the display role is elided containing the full display role information.

Note: The tooltip will only be shown if the Qt::ToolTipRole differs from Qt::DisplayRole, or if they match, showToolTipWhenElided flag is set and the display role information is elided.

See also: setShowToolTipWhenElided()

Since: 4.2

QSize KFileItemDelegate::sizeHint	(	const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

virtual

Returns the nominal size for the item referred to by index, given the provided options.

If the model provides a valid Qt::FontRole and/or Qt::AlignmentRole for the item, those will be used instead of the ones specified in the style options.

This function is reimplemented from QAbstractItemDelegate.

Parameters

option	The style options that should be used when painting the item.
index	The index to the item for which to return the size hint.

Definition at line 941 of file kfileitemdelegate.cpp.

void KFileItemDelegate::updateEditorGeometry	(	QWidget *	editor,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

virtual

Reimplemented from QAbstractItemDelegate.

Definition at line 1507 of file kfileitemdelegate.cpp.

QTextOption::WrapMode KFileItemDelegate::wrapMode ( ) const

Returns the wrapping strategy followed to show text when it needs wrapping.

Since: 4.4

Definition at line 1094 of file kfileitemdelegate.cpp.

Property Documentation

InformationList KFileItemDelegate::information

readwrite

This property holds which additional information (if any) should be shown below items in icon views.

Access functions:

void setShownformation(InformationList information)
InformationList showInformation() const

Definition at line 79 of file kfileitemdelegate.h.

bool KFileItemDelegate::jobTransfersVisible

readwrite

This property determines if there are KIO jobs on a destination URL visible, then they will have a small animation overlay displayed on them.

Since: 4.5

Definition at line 135 of file kfileitemdelegate.h.

QSize KFileItemDelegate::maximumSize

readwrite

This property holds the maximum size that can be returned by KFileItemDelegate::sizeHint().

If the maximum size is empty, it will be ignored.

Definition at line 119 of file kfileitemdelegate.h.

qreal KFileItemDelegate::shadowBlur

readwrite

This property holds the blur radius for the text shadow.

The default value for this property is 2.

Access functions:

void setShadowBlur(qreal radius)
qreal shadowBlur() const

Definition at line 112 of file kfileitemdelegate.h.

QColor KFileItemDelegate::shadowColor

readwrite

This property holds the color used for the text shadow.

The alpha value in the color determines the opacity of the shadow. Shadows are only rendered when the alpha value is non-zero. The default value for this property is Qt::transparent.

Access functions:

Definition at line 92 of file kfileitemdelegate.h.

QPointF KFileItemDelegate::shadowOffset

readwrite

This property holds the horizontal and vertical offset for the text shadow.

The default value for this property is (1, 1).

Access functions:

void setShadowOffset(const QPointF &offset)
QPointF shadowOffset() const

Definition at line 102 of file kfileitemdelegate.h.

bool KFileItemDelegate::showToolTipWhenElided

readwrite

This property determines whether a tooltip will be shown by the delegate if the display role is elided.

This tooltip will contain the full display role information. The tooltip will only be shown if the Qt::ToolTipRole differs from Qt::DisplayRole, or if they match, showToolTipWhenElided flag is set and the display role information is elided.

Definition at line 128 of file kfileitemdelegate.h.

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

KIO

Public Types

Public Slots

Public Member Functions

Properties

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

KIO

kdelibs API Reference

Search