KDE 4.0 API Reference KIO
KFileItemDelegate Class Reference
#include <kfileitemdelegate.h>
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 66 of file kfileitemdelegate.h.
Member Typedef Documentation
Definition at line 118 of file kfileitemdelegate.h.
Member Enumeration Documentation
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.
- Enumerator:
Definition at line 104 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 901 of file kfileitemdelegate.cpp.
| KFileItemDelegate::~KFileItemDelegate | ( | ) | [virtual] |
Member Function Documentation
| 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 932 of file kfileitemdelegate.cpp.
| 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.
- 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 1127 of file kfileitemdelegate.cpp.
| QWidget * KFileItemDelegate::createEditor | ( | QWidget * | parent, | |
| const QStyleOptionViewItem & | option, | |||
| const QModelIndex & | index | |||
| ) | const [virtual] |
| bool KFileItemDelegate::editorEvent | ( | QEvent * | event, | |
| QAbstractItemModel * | model, | |||
| const QStyleOptionViewItem & | option, | |||
| const QModelIndex & | index | |||
| ) | [virtual] |
Reimplemented from QAbstractItemDelegate.
Reimplemented from QAbstractItemDelegate.
Definition at line 1251 of file kfileitemdelegate.cpp.
| void KFileItemDelegate::setEditorData | ( | QWidget * | editor, | |
| const QModelIndex & | index | |||
| ) | const [virtual] |
| void KFileItemDelegate::setModelData | ( | QWidget * | editor, | |
| QAbstractItemModel * | model, | |||
| const QModelIndex & | index | |||
| ) | const [virtual] |
| void KFileItemDelegate::updateEditorGeometry | ( | QWidget * | editor, | |
| const QStyleOptionViewItem & | option, | |||
| const QModelIndex & | index | |||
| ) | const [virtual] |
| 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 988 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 994 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 1003 of file kfileitemdelegate.cpp.
| bool KFileItemDelegate::helpEvent | ( | QHelpEvent * | event, | |
| QAbstractItemView * | view, | |||
| const QStyleOptionViewItem & | option, | |||
| const QModelIndex & | index | |||
| ) | [slot] |
Reimplemented from QAbstractItemDelegate.
Reimplemented from QAbstractItemDelegate.
Definition at line 1285 of file kfileitemdelegate.cpp.
Property Documentation
InformationList KFileItemDelegate::information [read, write] |
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 78 of file kfileitemdelegate.h.
The documentation for this class was generated from the following files:
