# class KFileItemDelegate

###

Module | kio
Namespace |
Class | KFileItemDelegate
Inherits | QAbstractItemDelegate

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);

### enums

- Information { NoInformation, Size, Permissions, OctalPermissions, Owner, OwnerAndGroup, CreationTime, ModificationTime, AccessTime, MimeType, FriendlyMimeType }

enum details

### methods

- KFileItemDelegate (parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  parent | QObject | 0

  Constructs a new KFileItemDelegate.

  parent - The parent object for the delegate.

- KFileItemDelegate (a0)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  a0 | KFileItemDelegate |

- KFileItemDelegate (a0)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QObject | 0

- createEditor (parent, option, index)

  returns QWidget

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget |
  option | QStyleOptionViewItem |
  index | QModelIndex |

  Reimplemented from QAbstractItemDelegate.

- editorEvent (event, model, option, index)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  event | QEvent |
  model | QAbstractItemModel |
  option | QStyleOptionViewItem |
  index | QModelIndex |

  Reimplemented from QAbstractItemDelegate.

- eventFilter (object, event)

  returns bool
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  object | QObject |
  event | QEvent |

  Reimplemented from QAbstractItemDelegate.

- helpEvent (event, view, option, index)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  event | QHelpEvent |
  view | QAbstractItemView |
  option | QStyleOptionViewItem |
  index | QModelIndex |

  Reimplemented from QAbstractItemDelegate.

- maximumSize ( )

  returns QSize
  KDE 4.1.0 and later only

  Returns the maximum size for KFileItemDelegate.sizeHint().

  See also setMaximumSize() @since 4.1

- paint (painter, option, index)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  painter | QPainter |
  option | QStyleOptionViewItem |
  index | QModelIndex |

  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.

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.

- setEditorData (editor, index)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  editor | QWidget |
  index | QModelIndex |

  Reimplemented from QAbstractItemDelegate.

- setMaximumSize (size)

  returns Nothing
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  size | QSize |

  Sets the maximum size for KFileItemDelegate.sizeHint().

  See also maximumSize() @since 4.1

- setModelData (editor, model, index)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  editor | QWidget |
  model | QAbstractItemModel |
  index | QModelIndex |

  Reimplemented from QAbstractItemDelegate.

- setShadowBlur (radius)

  returns Nothing
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  radius | qreal |

  Sets the blur radius for the text shadow.

  See also shadowBlur()

- setShadowColor (color)

  returns Nothing
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  color | QColor |

  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()

- setShadowOffset (offset)

  returns Nothing
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  offset | QPointF |

  Sets the horizontal and vertical offset for the text shadow.

  See also shadowOffset()

- setShowInformation (list)

  returns Nothing
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  list | KFileItemDelegate.InformationList |

  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.

  list - A list of information items that should be shown

- setShowInformation (information)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  information | KFileItemDelegate.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.

  information - The information that should be shown

- shadowBlur ( )

  returns qreal
  KDE 4.1.0 and later only

  Returns the blur radius for the text shadow.

  See also setShadowBlur()

- shadowColor ( )

  returns QColor
  KDE 4.1.0 and later only

  Returns the color used for the text shadow.

  See also setShadowColor()

- shadowOffset ( )

  returns QPointF
  KDE 4.1.0 and later only

  Returns the offset used for the text shadow.

  See also setShadowOffset()

- showInformation ( )

  returns KFileItemDelegate.InformationList
  Not implemented

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

- sizeHint (option, index)

  returns QSize

  Argument | Type | Default
  --- | --- | ---
  option | QStyleOptionViewItem |
  index | QModelIndex |

  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.

  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.

- updateEditorGeometry (editor, option, index)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  editor | QWidget |
  option | QStyleOptionViewItem |
  index | QModelIndex |

  Reimplemented from QAbstractItemDelegate.

### enums - detail

- Information { NoInformation, Size, Permissions, OctalPermissions, Owner, OwnerAndGroup, CreationTime, ModificationTime, AccessTime, MimeType, FriendlyMimeType }

  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()

  See also showInformation()

  See also information

  | NoInformation | - | - |
  | Size | - | - |
  | Permissions | - | - |
  | OctalPermissions | - | - |
  | Owner | - | - |
  | OwnerAndGroup | - | - |
  | CreationTime | - | - |
  | ModificationTime | - | - |
  | AccessTime | - | - |
  | MimeType | - | - |
  | FriendlyMimeType | - | - |