• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KIO

  • KIO
  • MetaInfoJob
Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KIO::MetaInfoJob Class Reference

#include <metainfojob.h>

Inheritance diagram for KIO::MetaInfoJob:
KIO::Job KCompositeJob KJob QObject

Signals

void failed (const KFileItem &item)
 
void gotMetaInfo (const KFileItem &item)
 
- Signals inherited from KIO::Job
void canceled (KJob *job)
 
void connected (KIO::Job *job)
 
- Signals inherited from KJob
void description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
 
void finished (KJob *job)
 
void infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
 
void percent (KJob *job, unsigned long percent)
 
void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void processedSize (KJob *job, qulonglong size)
 
void result (KJob *job)
 
void resumed (KJob *job)
 
void speed (KJob *job, unsigned long speed)
 
void suspended (KJob *job)
 
void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void totalSize (KJob *job, qulonglong size)
 
void warning (KJob *job, const QString &plain, const QString &rich=QString())
 

Public Member Functions

 MetaInfoJob (const KFileItemList &items, KFileMetaInfo::WhatFlags w=KFileMetaInfo::Everything, int iocost=3, int cpucost=6, const QStringList &requiredfields=QStringList(), const QStringList &requestedfields=QStringList())
 
virtual ~MetaInfoJob ()
 
void removeItem (const KFileItem &item)
 
- Public Member Functions inherited from KIO::Job
virtual ~Job ()
 
void addMetaData (const QMap< QString, QString > &values)
 
void addMetaData (const QString &key, const QString &value)
 
QStringList detailedErrorStrings (const KUrl *reqUrl=0L, int method=-1) const
 
QString errorString () const
 
bool isInteractive () const
 
void mergeMetaData (const QMap< QString, QString > &values)
 
MetaData metaData () const
 
MetaData outgoingMetaData () const
 
Job * parentJob () const
 
QString queryMetaData (const QString &key)
 
void setMetaData (const KIO::MetaData &metaData)
 
void setParentJob (Job *parentJob)
 
void showErrorDialog (QWidget *parent=0)
 
void start ()
 
JobUiDelegate * ui () const
 
- Public Member Functions inherited from KCompositeJob
 KCompositeJob (QObject *parent=0)
 
virtual ~KCompositeJob ()
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=0)
 
virtual ~KJob ()
 
Capabilities capabilities () const
 
int error () const
 
virtual QString errorString () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isSuspended () const
 
unsigned long percent () const
 
qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
virtual void start ()=0
 
qulonglong totalAmount (Unit unit) const
 
KJobUiDelegate * uiDelegate () const
 

Protected Slots

virtual void slotResult (KJob *job)
 
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
 
virtual void slotResult (KJob *job)
 

Protected Member Functions

void getMetaInfo ()
 
- Protected Member Functions inherited from KIO::Job
 Job ()
 
 Job (JobPrivate &dd)
 
virtual bool addSubjob (KJob *job)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
virtual bool removeSubjob (KJob *job)
 
- Protected Member Functions inherited from KCompositeJob
 KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
 
virtual bool addSubjob (KJob *job)
 
void clearSubjobs ()
 
bool hasSubjobs ()
 
virtual bool removeSubjob (KJob *job)
 
const QList< KJob * > & subjobs () const
 
- Protected Member Functions inherited from KJob
 KJob (KJobPrivate &dd, QObject *parent)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
 
void emitResult ()
 
void emitSpeed (unsigned long speed)
 
void setCapabilities (Capabilities capabilities)
 
void setError (int errorCode)
 
void setErrorText (const QString &errorText)
 
void setPercent (unsigned long percentage)
 
void setProcessedAmount (Unit unit, qulonglong amount)
 
void setTotalAmount (Unit unit, qulonglong amount)
 

Additional Inherited Members

- Public Types inherited from KJob
enum  Capability
 
enum  KillVerbosity
 
enum  Unit
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
 
bool resume ()
 
bool suspend ()
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 EmitResult
 
 Files
 
 Killable
 
 KilledJobError
 
 NoCapabilities
 
 NoError
 
 Quietly
 
 Suspendable
 
 UserDefinedError
 
- Protected Attributes inherited from KJob
KJobPrivate *const d_ptr
 

Detailed Description

MetaInfoJob is a KIO Job to retrieve meta information from files.

KIO Job to retrieve meta information from files.

Definition at line 35 of file metainfojob.h.

Constructor & Destructor Documentation

◆ MetaInfoJob()

MetaInfoJob::MetaInfoJob ( const KFileItemList &  items,
KFileMetaInfo::WhatFlags  w = KFileMetaInfo::Everything,
int  iocost = 3,
int  cpucost = 6,
const QStringList &  requiredfields = QStringList(),
const QStringList &  requestedfields = QStringList() 
)
explicit

Creates a new MetaInfoJob.

Parameters
itemsA list of KFileItems to get the metainfo for
wFlags which serve as a preset which can be customized with other parameters.
iocostThe allowed cost in terms of io to retrieve the metainfo. The approximate maximum number of bytes to be read is 10^iocost. Negative values mean that there is no limit on the cost. 0 means that no fields other than the required fields will be retrieved. The default value of 3 means about 1024 bytes per file may be read. This is merely a suggestion and not a hard limit.
cpucostThe allowed cost in terms of cpu to determine the information in the fields. The number mean the amount of instructions allowed is 10^cpucost and is a suggestion only. The default value of 6 means that about a million instructions (10^6) are allowed. This is useful for expensive fields like md5 or thumbnails.
requiredfieldsThe names of fields or groups of fields that should be retrieved regardless of cost.
requestedfieldsThe names of fields or groups of fields that should be retrieved first.

Definition at line 45 of file metainfojob.cpp.

◆ ~MetaInfoJob()

MetaInfoJob::~MetaInfoJob ( )
virtual

Definition at line 68 of file metainfojob.cpp.

Member Function Documentation

◆ failed

void KIO::MetaInfoJob::failed ( const KFileItem &  item)
signal
Emitted when metainfo for @p item could not be extracted,
either because a plugin for its MIME type does not
exist, or because something went wrong.
Parameters
itemthe KFileItem of the file that failed

◆ getMetaInfo()

void MetaInfoJob::getMetaInfo ( )
protected

Definition at line 125 of file metainfojob.cpp.

◆ gotMetaInfo

void KIO::MetaInfoJob::gotMetaInfo ( const KFileItem &  item)
signal
Emitted when the meta info for @p item has been successfully
retrieved.
Parameters
itemthe KFileItem describing the fetched item

◆ removeItem()

void MetaInfoJob::removeItem ( const KFileItem &  item)

Removes an item from metainfo extraction.

Parameters
itemthe item that should be removed from the queue

Definition at line 77 of file metainfojob.cpp.

◆ slotResult

void MetaInfoJob::slotResult ( KJob *  job)
protectedvirtualslot

Definition at line 117 of file metainfojob.cpp.


The documentation for this class was generated from the following files:
  • metainfojob.h
  • metainfojob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal