• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KFile

KFilePreviewGenerator Class Reference

Generates previews for files of an item view. More...

#include <kfilepreviewgenerator.h>

Inheritance diagram for KFilePreviewGenerator:

Inheritance graph
[legend]

List of all members.


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 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 864 of file kfilepreviewgenerator.cpp.

KFilePreviewGenerator::KFilePreviewGenerator ( KAbstractViewAdapter *  parent,
QAbstractProxyModel *  model 
)

For internal use only.

Definition at line 871 of file kfilepreviewgenerator.cpp.

KFilePreviewGenerator::~KFilePreviewGenerator (  )  [virtual]

Definition at line 877 of file kfilepreviewgenerator.cpp.


Member Function Documentation

void KFilePreviewGenerator::cancelPreviews (  ) 

Cancels all pending previews.

Definition at line 938 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 951 of file kfilepreviewgenerator.cpp.

bool KFilePreviewGenerator::isPreviewShown (  )  const

Definition at line 910 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 946 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 882 of file kfilepreviewgenerator.cpp.

void KFilePreviewGenerator::updatePreviews (  ) 

Updates the previews for all already available 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().

Definition at line 915 of file kfilepreviewgenerator.cpp.


The documentation for this class was generated from the following files:
  • kfilepreviewgenerator.h
  • kfilepreviewgenerator.cpp

KFile

Skip menu "KFile"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal