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

KIO

KIO::MetaInfoJob

KIO::MetaInfoJob Class Reference

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

#include <metainfojob.h>

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

List of all members.

Signals

void failed (const KFileItem &item)
void gotMetaInfo (const KFileItem &item)

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())
void removeItem (const KFileItem &item)
virtual ~MetaInfoJob ()

Protected Slots

virtual void slotResult (KJob *job)

Protected Member Functions

void getMetaInfo ()

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 ( 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:
items A list of KFileItems to get the metainfo for
w Flags which serve as a preset which can be customized with other parameters.
iocost The 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.
cpucost The 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.
requiredfields The names of fields or groups of fields that should be retrieved regardless of cost.
requestedfields The names of fields or groups of fields that should be retrieved first.

Definition at line 45 of file metainfojob.cpp.

MetaInfoJob::~MetaInfoJob (  )  [virtual]

Definition at line 68 of file metainfojob.cpp.


Member Function Documentation

void KIO::MetaInfoJob::failed ( const KFileItem &  item  )  [signal]

Emitted when metainfo for item could not be extracted, either because a plugin for its MIME type does not exist, or because something went wrong.

Parameters:
item the KFileItem of the file that failed
void MetaInfoJob::getMetaInfo (  )  [protected]

Definition at line 125 of file metainfojob.cpp.

void KIO::MetaInfoJob::gotMetaInfo ( const KFileItem &  item  )  [signal]

Emitted when the meta info for item has been successfully retrieved.

Parameters:
item the KFileItem describing the fetched item
void MetaInfoJob::removeItem ( const KFileItem &  item  ) 

Removes an item from metainfo extraction.

Parameters:
item the item that should be removed from the queue

Definition at line 77 of file metainfojob.cpp.

void MetaInfoJob::slotResult ( KJob *  job  )  [protected, virtual, slot]

Reimplemented from KCompositeJob.

Definition at line 117 of file metainfojob.cpp.


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

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • 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
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
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