.TH "KIO::PreviewJob" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::PreviewJob \- 
.SH SYNOPSIS
.br
.PP
\fC#include <previewjob.h>\fP
.PP
Inherits \fBKIO::Job\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBgotPreview\fP (const  \fBKFileItem\fP *item, const  \fBQPixmap\fP &preview)"
.br
.RI "\fIEmitted when a thumbnail picture for \fCitem\fP has been successfully retrieved. \fP"
.ti -1c
.RI "void \fBfailed\fP (const  \fBKFileItem\fP *item)"
.br
.RI "\fIEmitted when a thumbnail for \fCitem\fP could not be created, either because a \fBThumbCreator\fP for its MIME type does not exist, or because something went wrong. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBPreviewJob\fP (const  \fBKFileItemList\fP &items, int width, int height, int iconSize, int iconAlpha, bool scale, bool save, const  \fBQStringList\fP *enabledPlugins, bool deleteItems=false)"
.br
.ti -1c
.RI "void \fBremoveItem\fP (const  \fBKFileItem\fP *item)"
.br
.RI "\fIRemoves an item from preview processing. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQStringList\fP \fBavailablePlugins\fP ()"
.br
.ti -1c
.RI "\fBQStringList\fP \fBsupportedMimeTypes\fP ()"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBslotResult\fP (\fBKIO::Job\fP *job)"
.br
.RI "\fICalled whenever a subjob finishes. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBgetOrCreateThumbnail\fP ()"
.br
.ti -1c
.RI "bool \fBstatResultThumbnail\fP ()"
.br
.ti -1c
.RI "void \fBcreateThumbnail\fP (\fBQString\fP)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This class catches a preview (thumbnail) for files Definition at line 36 of file previewjob.h.
.SH "Member Function Documentation"
.PP 
.SS "void PreviewJob::removeItem (const \fBKFileItem\fP * item)"
.PP
Removes an item from preview processing. Use this if you passed an item to \fBfilePreview\fP and want to delete it now.
.PP
\fBParameters:\fP
.RS 4
\fIitem\fP the item that should be removed from the preview queue 
.RE
.PP
Definition at line 209 of file previewjob.cpp.
.PP
References QPtrList< Job >::first(), and QPtrList< Job >::removeFirst().
.SS "\fBQStringList\fP PreviewJob::availablePlugins ()\fC [static]\fP"
.PP
\fBReturns:\fP
.RS 4
a list of all available preview plugins. The list contains the basenames of the plugins' .desktop files (no path, no .desktop). 
.RE
.PP
Definition at line 475 of file previewjob.cpp.
.PP
References QValueList::begin(), QValueList::end(), KTrader::OfferList, KTrader::query(), KIO::Job::result(), and KTrader::self().
.SS "\fBQStringList\fP PreviewJob::supportedMimeTypes ()\fC [static]\fP"
.PP
\fBReturns:\fP
.RS 4
a list of all supported MIME types. The list can contain entries like text/ * (without the space). 
.RE
.PP
Definition at line 485 of file previewjob.cpp.
.PP
References QValueList::begin(), QValueList::end(), KTrader::OfferList, KTrader::query(), KIO::Job::result(), and KTrader::self().
.PP
Referenced by KFileIconView::showPreviews().
.SS "void KIO::PreviewJob::gotPreview (const \fBKFileItem\fP * item, const \fBQPixmap\fP & preview)\fC [signal]\fP"
.PP
Emitted when a thumbnail picture for \fCitem\fP has been successfully retrieved. 
.SS "void KIO::PreviewJob::failed (const \fBKFileItem\fP * item)\fC [signal]\fP"
.PP
Emitted when a thumbnail for \fCitem\fP could not be created, either because a \fBThumbCreator\fP for its MIME type does not exist, or because something went wrong. 
.SS "void PreviewJob::slotResult (\fBKIO::Job\fP * job)\fC [protected, virtual, slot]\fP"
.PP
Called whenever a subjob finishes. Default implementation checks for errors and propagates to parent job, then calls \fBremoveSubjob\fP. Override if you don't want subjobs errors to be propagated. Reimplemented from \fBKIO::Job\fP.
.PP
Definition at line 253 of file previewjob.cpp.
.PP
References QValueList::begin(), QValueList::end(), KIO::Job::error(), QPtrList< Job >::isEmpty(), QFile::remove(), QPtrList< Job >::remove(), and KIO::UDSEntry.

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
