KFile
KFilePreviewGenerator Class Reference
Generates previews for files of an item view. More...
#include <kfilepreviewgenerator.h>

Public Member Functions | |
void | cancelPreviews () |
QStringList | enabledPlugins () const |
bool | isPreviewShown () const |
KFilePreviewGenerator (KAbstractViewAdapter *parent, QAbstractProxyModel *model) | |
KFilePreviewGenerator (QAbstractItemView *parent) | |
void | setEnabledPlugins (const QStringList &list) |
void | setPreviewShown (bool show) |
void | updateIcons () |
void | updatePreviews () |
virtual | ~KFilePreviewGenerator () |
Detailed Description
Generates previews for files of an item view.
Per default a preview is generated for each item. Additionally the clipboard is checked for cut items. The icon state for cut items gets dimmed automatically.
The following strategy is used when creating previews:
- The previews for currently visible items are created before the previews for invisible items.
- If the user changes the visible area by using the scrollbars, all pending previews get paused. As soon as the user stays on the same position for a short delay, the previews are resumed. Also in this case the previews for the visible items are generated first.
- Since:
- 4.2
Definition at line 50 of file kfilepreviewgenerator.h.
Constructor & Destructor Documentation
KFilePreviewGenerator::KFilePreviewGenerator | ( | QAbstractItemView * | parent | ) |
- Parameters:
-
parent Item view containing the file items where previews should be generated. It is mandatory that the item view specifies an icon size by QAbstractItemView::setIconSize() and that the model of the view (or the source model of the proxy model) is an instance of KDirModel. Otherwise no previews will be generated.
Definition at line 1118 of file kfilepreviewgenerator.cpp.
KFilePreviewGenerator::KFilePreviewGenerator | ( | KAbstractViewAdapter * | parent, | |
QAbstractProxyModel * | model | |||
) |
KFilePreviewGenerator::~KFilePreviewGenerator | ( | ) | [virtual] |
Definition at line 1131 of file kfilepreviewgenerator.cpp.
Member Function Documentation
void KFilePreviewGenerator::cancelPreviews | ( | ) |
Cancels all pending previews.
Definition at line 1175 of file kfilepreviewgenerator.cpp.
QStringList KFilePreviewGenerator::enabledPlugins | ( | ) | const |
Returns the list of enabled thumbnail plugins, or an empty list if all plugins are enabled.
- See also:
- setEnabledPlugins
Definition at line 1188 of file kfilepreviewgenerator.cpp.
bool KFilePreviewGenerator::isPreviewShown | ( | ) | const |
Definition at line 1150 of file kfilepreviewgenerator.cpp.
void KFilePreviewGenerator::setEnabledPlugins | ( | const QStringList & | list | ) |
Sets the list of enabled thumbnail plugins.
If the list is empty, all plugins will be enabled. All plugins are enabled by default.
Note that this method doesn't cause already generated previews to be regenerated.
For a list of available plugins, call KServiceTypeTrader::self()->query("ThumbCreator").
- See also:
- enabledPlugins
Definition at line 1183 of file kfilepreviewgenerator.cpp.
void KFilePreviewGenerator::setPreviewShown | ( | bool | show | ) |
If show is set to true, a preview is generated for each item.
If show is false, the MIME type icon of the item is shown instead. Per default showing the preview is turned on. Note that it is mandatory that the item view specifies an icon size by QAbstractItemView::setIconSize(), otherwise KFilePreviewGenerator::isPreviewShown() will always return false.
Definition at line 1136 of file kfilepreviewgenerator.cpp.
void KFilePreviewGenerator::updateIcons | ( | ) |
Updates the icons for all items.
Usually it is only necessary to invoke this method when the icon size of the abstract item view has been changed by QAbstractItemView::setIconSize(). Note that this method should also be invoked if previews have been turned off, as the icons for cut items must be updated when the icon size has changed.
- Since:
- 4.3
Definition at line 1161 of file kfilepreviewgenerator.cpp.
void KFilePreviewGenerator::updatePreviews | ( | ) |
- Deprecated:
- Use KFilePreviewGenerator::updateIcons() instead.
Definition at line 1156 of file kfilepreviewgenerator.cpp.
The documentation for this class was generated from the following files: