KFileItem

#include <KFileItem>

Public Types
enum	{ Unknown = static_cast<mode_t>(-1) }

enum	FileTimes { ModificationTime = 0, AccessTime = 1, CreationTime = 2 }

enum	MimeTypeDetermination { NormalMimeTypeDetermination = 0, SkipMimeTypeFromContent }

Properties
QString	comment

QMimeType	currentMimeType

QMimeType	determineMimeType

QString	getStatusBarInfo

QString	group

QString	iconName

bool	isDesktopFile

bool	isDir

bool	isFile

bool	isFinalIconKnown

bool	isHidden

bool	isLink

bool	isLocalFile

bool	isMimeTypeKnown

bool	isReadable

bool	isRegularFile

bool	isSlow

bool	isWritable

QString	linkDest

QString	localPath

QString	mimeComment

QString	mimetype

QString	name

QStringList	overlays

QUrl	targetUrl

QString	text

QUrl	url

QString	user

Public Member Functions
	KFileItem ()

	KFileItem (const KFileItem &)

	KFileItem (const KIO::UDSEntry &entry, const QUrl &itemOrDirUrl, bool delayedMimeTypes=false, bool urlIsDirectory=false)

	KFileItem (const QUrl &url, const QString &mimeType=QString(), mode_t mode=KFileItem::Unknown)

	KFileItem (const QUrl &url, KFileItem::MimeTypeDetermination mimeTypeDetermination)

	KFileItem (KFileItem &&)

	KFileItem (mode_t mode, mode_t permissions, const QUrl &url, bool delayedMimeTypes=false)

	~KFileItem ()

bool	acceptsDrops () const

KACL	ACL () const

void	assign (const KFileItem &item)

bool	cmp (const KFileItem &item) const

QString	comment () const

QMimeType	currentMimeType () const

KACL	defaultACL () const

QMimeType	determineMimeType () const

KIO::UDSEntry	entry () const

QString	getStatusBarInfo () const

QString	group () const

bool	hasExtendedACL () const

QString	iconName () const

bool	isDesktopFile () const

bool	isDir () const

bool	isFile () const

bool	isFinalIconKnown () const

bool	isHidden () const

bool	isLink () const

bool	isLocalFile () const

bool	isMimeTypeKnown () const

MostLocalUrlResult	isMostLocalUrl () const

bool	isNull () const

bool	isReadable () const

bool	isRegularFile () const

bool	isSlow () const

bool	isWritable () const

QString	linkDest () const

QString	localPath () const

QString	mimeComment () const

QString	mimetype () const

mode_t	mode () const

QUrl	mostLocalUrl (bool &local) const

QUrl	mostLocalUrl (bool *local=nullptr) const

QString	name (bool lowerCase=false) const

	operator QVariant () const

bool	operator!= (const KFileItem &other) const

bool	operator< (const KFileItem &other) const

bool	operator< (const QUrl &other) const

KFileItem &	operator= (const KFileItem &)

KFileItem &	operator= (KFileItem &&)

bool	operator== (const KFileItem &other) const

QStringList	overlays () const

mode_t	permissions () const

QString	permissionsString () const

KIO::filesize_t	recursiveSize () const

void	refresh ()

void	refreshMimeType ()

void	setDelayedMimeTypes (bool b)

void	setLocalPath (const QString &path)

void	setName (const QString &name)

void	setUrl (const QUrl &url)

KIO::filesize_t	size () const

QUrl	targetUrl () const

QString	text () const

Q_INVOKABLE QDateTime	time (FileTimes which) const

Q_INVOKABLE QString	timeString (FileTimes which=ModificationTime) const

QString	timeString (unsigned int which) const

QUrl	url () const

QString	user () const

Detailed Description

A KFileItem is a generic class to handle a file, local or remote. In particular, it makes it easier to handle the result of KIO::listDir (UDSEntry isn't very friendly to use). It includes many file attributes such as MIME type, icon, text, mode, link...

KFileItem is implicitly shared, i.e. it can be used as a value and copied around at almost no cost.

Definition at line 35 of file kfileitem.h.

Member Enumeration Documentation

◆ FileTimes

enum KFileItem::FileTimes

The timestamps associated with a file.

ModificationTime: the time the file's contents were last modified
AccessTime: the time the file was last accessed (last read or written to)
CreationTime: the time the file was created

Definition at line 77 of file kfileitem.h.

Constructor & Destructor Documentation

◆ KFileItem() [1/7]

KFileItem::KFileItem ( )

Null KFileItem.

Doesn't represent any file, only exists for convenience.

Definition at line 559 of file kfileitem.cpp.

◆ KFileItem() [2/7]

KFileItem::KFileItem	(	const KIO::UDSEntry &	entry,
		const QUrl &	itemOrDirUrl,
		bool	delayedMimeTypes = `false`,
		bool	urlIsDirectory = `false`
	)

Creates an item representing a file, from a UDSEntry.

This is the preferred constructor when using KIO::listDir().

Parameters

entry	the KIO entry used to get the file, contains info about it
itemOrDirUrl	the URL of the item or of the directory containing this item (see urlIsDirectory).
delayedMimeTypes	specifies if the MIME type of the given URL should be determined immediately or on demand. See the bool delayedMimeTypes in the KDirLister constructor.
urlIsDirectory	specifies if the url is just the directory of the fileitem and the filename from the UDSEntry should be used.

When creating KFileItems out of the UDSEntry emitted by a KIO list job, use KFileItem(entry, listjob->url(), delayedMimeTypes, true);

Definition at line 564 of file kfileitem.cpp.

◆ KFileItem() [3/7]

KFileItem::KFileItem	(	mode_t	mode,
		mode_t	permissions,
		const QUrl &	url,
		bool	delayedMimeTypes = `false`
	)

Creates an item representing a file, from all the necessary info for it.

Parameters

mode	the file mode (according to stat() (e.g. S_IFDIR...) Set to KFileItem::Unknown if unknown. For local files, KFileItem will use stat().
permissions	the access permissions If you set both the mode and the permissions, you save a stat() for local files. Set to KFileItem::Unknown if you don't know the mode or the permission.
url	the file url
delayedMimeTypes	specify if the MIME type of the given URL should be determined immediately or on demand

Deprecated:: since 5.0. Most callers gave Unknown for mode and permissions, so just port to KFileItem(url) and setDelayedMimeTypes(true) if necessary.

Definition at line 576 of file kfileitem.cpp.

◆ KFileItem() [4/7]

KFileItem::KFileItem	(	const QUrl &	url,
		const QString &	mimeType = `QString()`,
		mode_t	mode = `KFileItem::Unknown`
	)

Creates an item representing a file, for which the MIME type is already known.

Parameters

url	the file url
mimeType	the name of the file's MIME type
mode	the mode (S_IFDIR...)

Definition at line 582 of file kfileitem.cpp.

◆ KFileItem() [5/7]

KFileItem::KFileItem	(	const QUrl &	url,
		KFileItem::MimeTypeDetermination	mimeTypeDetermination
	)

Creates an item representing a file, with the option of skipping MIME type determination.

Parameters

url	the file url
mimeTypeDetermination	the mode of determining the MIME type: NormalMimeTypeDetermination by content if local file, i.e. access the file, open and read part of it; by QMimeDatabase::MatchMode::MatchExtension if not local. SkipMimeTypeFromContent always by QMimeDatabase::MatchMode::MatchExtension, i.e. won't access the file by stat() or opening it; only suitable for files, directories won't be recognized.

Since: 5.57

Definition at line 592 of file kfileitem.cpp.

◆ KFileItem() [6/7]

KFileItem::KFileItem ( const KFileItem & )

default

Copy constructor.

◆ ~KFileItem()

KFileItem::~KFileItem ( )

default

Destructor.

◆ KFileItem() [7/7]

KFileItem::KFileItem ( KFileItem && )

default

Move constructor.

Since: 5.43

Member Function Documentation

◆ acceptsDrops()

bool KFileItem::acceptsDrops ( ) const

Returns true if files can be dropped over this item.

Contrary to popular belief, not only dirs will return true :) Executables, .desktop files, will do so as well.

Returns: true if you can drop files over the item

Deprecated:: Since 4.0. This logic is application-dependent, the behavior described above mostly makes sense for file managers only. KDirModel has setDropsAllowed for similar (but configurable) logic.

Definition at line 1314 of file kfileitem.cpp.

◆ ACL()

KACL KFileItem::ACL ( ) const

Returns the access control list for the file.

Returns: the access control list as a KACL

Definition at line 763 of file kfileitem.cpp.

◆ assign()

void KFileItem::assign ( const KFileItem & item )

Deprecated:: Since 4.0, simply use '='

Definition at line 1476 of file kfileitem.cpp.

◆ cmp()

bool KFileItem::cmp ( const KFileItem & item ) const

Somewhat like a comparison operator, but more explicit, and it can detect that two fileitems differ if any property of the file item has changed (file size, modification date, etc.).

Two items are equal if all properties are equal. In contrast, operator== only compares URLs.

Parameters

item	the item to compare

Returns: true if all values are equal

Definition at line 1376 of file kfileitem.cpp.

◆ comment()

QString KFileItem::comment ( ) const

A comment which can contain anything - even rich text.

It will simply be displayed to the user as is.

Since: 4.6

◆ currentMimeType()

QMimeType KFileItem::currentMimeType ( ) const

Returns the currently known MIME type of the file item.

This will not try to determine the MIME type if unknown.

Returns: the known MIME type

◆ defaultACL()

KACL KFileItem::defaultACL ( ) const

Returns the default access control list for the directory.

Returns: the default access control list as a KACL

Definition at line 781 of file kfileitem.cpp.

◆ determineMimeType()

QMimeType KFileItem::determineMimeType ( ) const

Returns the MIME type of the file item.

If delayedMimeTypes was used in the constructor, this will determine the MIME type first.

Returns: the MIME type

◆ entry()

KIO::UDSEntry KFileItem::entry ( ) const

Returns the UDS entry.

Used by the tree view to access all details by position.

Returns: the UDS entry

Definition at line 1689 of file kfileitem.cpp.

◆ getStatusBarInfo()

QString KFileItem::getStatusBarInfo ( ) const

Returns the string to be displayed in the statusbar, e.g. when the mouse is over this item.

Returns: the status bar information

◆ group()

QString KFileItem::group ( ) const

Returns the group of the file.

Returns: the file's group

◆ hasExtendedACL()

bool KFileItem::hasExtendedACL ( ) const

Tells if the file has extended access level information ( Posix ACL )

Returns: true if the file has extend ACL information or false if it hasn't

Definition at line 753 of file kfileitem.cpp.

◆ iconName()

QString KFileItem::iconName ( ) const

Returns the full path name to the icon that represents this MIME type.

Returns: iconName the name of the file's icon

◆ isDesktopFile()

bool KFileItem::isDesktopFile ( ) const

Checks whether the file is a readable local .desktop file, i.e. a file whose path can be given to KDesktopFile.

Returns: true if the file is a desktop file.

Since: 4.1

◆ isDir()

bool KFileItem::isDir ( ) const

Returns true if this item represents a directory.

Returns: true if the item is a directory

◆ isFile()

bool KFileItem::isFile ( ) const

Returns true if this item represents a file (and not a directory)

Returns: true if the item is a file

◆ isFinalIconKnown()

bool KFileItem::isFinalIconKnown ( ) const

Returns: true if we have determined the final icon of this file already.

Since: 4.10.2

◆ isHidden()

bool KFileItem::isHidden ( ) const

Checks whether the file is hidden.

Returns: true if the file is hidden.

◆ isLink()

bool KFileItem::isLink ( ) const

Returns true if this item represents a link in the UNIX sense of a link.

Returns: true if the file is a link

◆ isLocalFile()

bool KFileItem::isLocalFile ( ) const

Returns true if the file is a local file.

Returns: true if the file is local, false otherwise

◆ isMimeTypeKnown()

bool KFileItem::isMimeTypeKnown ( ) const

Returns: true if we have determined the MIME type of this file already, i.e. if determineMimeType() will be fast. Otherwise it will have to find what the MIME type is, which is a possibly slow operation; usually this is delayed until necessary.

◆ isMostLocalUrl()

KFileItem::MostLocalUrlResult KFileItem::isMostLocalUrl ( ) const

Returns a MostLocalUrlResult, with the local Url for this item if possible (otherwise an empty Url), and a bool that is set to true if this Url does represent a local file otherwise false.

Basically this is an alternative to mostLocalUrl(bool*), that does not use an output parameter.

Example:

KFileItem item;
const MostLocalUrlResult result = item.isMostLocalUrl();
if (result.local) { // A local file
   // Use result.url
}

Since: 5.84

Definition at line 1495 of file kfileitem.cpp.

◆ isNull()

bool KFileItem::isNull ( ) const

Return true if default-constructed.

Definition at line 1700 of file kfileitem.cpp.

◆ isReadable()

bool KFileItem::isReadable ( ) const

Checks whether the file or directory is readable.

In some cases (remote files), we may return true even though it can't be read.

Returns: true if the file can be read - more precisely, false if we know for sure it can't

◆ isRegularFile()

bool KFileItem::isRegularFile ( ) const

Return true if this item is a regular file, false otherwise (directory, link, character/block device, fifo, socket)

Since: 4.3

◆ isSlow()

bool KFileItem::isSlow ( ) const

Returns: true if the file is a remote URL, or a local file on a network mount. It will return false only for really-local file systems.

Since: 4.7.4

◆ isWritable()

bool KFileItem::isWritable ( ) const

Checks whether the file or directory is writable.

In some cases (remote files), we may return true even though it can't be written to.

Returns: true if the file or directory can be written to - more precisely, false if we know for sure it can't

◆ linkDest()

QString KFileItem::linkDest ( ) const

Returns the link destination if isLink() == true.

Returns: the link destination. QString() if the item is not a link

◆ localPath()

QString KFileItem::localPath ( ) const

Returns the local path if isLocalFile() == true or the KIO item has a UDS_LOCAL_PATH atom.

Returns: the item local path, or QString() if not known

◆ mimeComment()

QString KFileItem::mimeComment ( ) const

Returns the user-readable string representing the type of this file, like "OpenDocument Text File".

Returns: the type of this KFileItem

◆ mimetype()

QString KFileItem::mimetype ( ) const

Returns the MIME type of the file item.

If delayedMimeTypes was used in the constructor, this will determine the MIME type first. Equivalent to determineMimeType()->name()

Returns: the MIME type of the file

◆ mode()

mode_t KFileItem::mode ( ) const

Returns the file type (stat.st_mode containing only S_IFDIR, S_IFLNK, ...).

Returns: the file type

Definition at line 1576 of file kfileitem.cpp.

◆ mostLocalUrl() [1/2]

QUrl KFileItem::mostLocalUrl ( bool & local ) const

inline

Deprecated:: since 5.0 add '&' in front of your boolean argument

Definition at line 616 of file kfileitem.h.

◆ mostLocalUrl() [2/2]

QUrl KFileItem::mostLocalUrl ( bool * local = nullptr ) const

Tries to return a local URL for this file item if possible.

If local is not null, it will be set to true if the returned url is local, false otherwise.

Example:

bool isLocal = false;
KFileItem item;
const QUrl url = item.mostLocalUrl(&isLocal);
if (isLocal) {
   // Use url
}

Since: 4.6

Definition at line 1482 of file kfileitem.cpp.

◆ name()

QString KFileItem::name ( bool lowerCase = false ) const

Return the name of the file item (without a path).

Similar to text(), but unencoded, i.e. the original name.

Parameters

lowerCase if true, the name will be returned in lower case, which is useful to speed up sorting by name, case insensitively.

Returns: the file's name

Definition at line 1616 of file kfileitem.cpp.

◆ operator QVariant()

KFileItem::operator QVariant ( ) const

Converts this KFileItem to a QVariant, this allows to use KFileItem in QVariant() constructor.

Definition at line 1426 of file kfileitem.cpp.

◆ operator!=()

bool KFileItem::operator!= ( const KFileItem & other ) const

Returns true if both items do not share the same URL.

Definition at line 1402 of file kfileitem.cpp.

◆ operator<() [1/2]

bool KFileItem::operator< ( const KFileItem & other ) const

Returns true if this item's URL is lexically less than other's URL; otherwise returns false.

Since: 5.48

Definition at line 1407 of file kfileitem.cpp.

◆ operator<() [2/2]

bool KFileItem::operator< ( const QUrl & other ) const

Returns true if this item's URL is lexically less than url other; otherwise returns false.

Since: 5.48

Definition at line 1418 of file kfileitem.cpp.

◆ operator=() [1/2]

KFileItem & KFileItem::operator= ( const KFileItem & )

default

Copy assignment.

◆ operator=() [2/2]

KFileItem & KFileItem::operator= ( KFileItem && )

default

Move assignment.

Since: 5.43

◆ operator==()

bool KFileItem::operator== ( const KFileItem & other ) const

Returns true if both items share the same URL.

Definition at line 1389 of file kfileitem.cpp.

◆ overlays()

QStringList KFileItem::overlays ( ) const

Returns the overlays (bitfield of KIconLoader::*Overlay flags) that are used for this item's pixmap.

Overlays are used to show for example, whether a file can be modified.

Returns: the overlays of the pixmap

◆ permissions()

mode_t KFileItem::permissions ( ) const

Returns the permissions of the file (stat.st_mode containing only permissions).

Returns: the permissions of the file

Definition at line 1565 of file kfileitem.cpp.

◆ permissionsString()

QString KFileItem::permissionsString ( ) const

Returns the access permissions for the file as a string.

Returns: the access permission as string

Definition at line 1431 of file kfileitem.cpp.

◆ recursiveSize()

KIO::filesize_t KFileItem::recursiveSize ( ) const

For folders, its recursive size: the size of its files plus the recursiveSize of its folder.

Initially only implemented for trash:/

Since: 5.70

Returns: The recursive size

Definition at line 744 of file kfileitem.cpp.

◆ refresh()

void KFileItem::refresh ( )

Throw away and re-read (for local files) all information about the file.

This is called when the file changes.

Definition at line 610 of file kfileitem.cpp.

◆ refreshMimeType()

void KFileItem::refreshMimeType ( )

Re-reads MIME type information.

This is called when the MIME type database changes.

Definition at line 635 of file kfileitem.cpp.

◆ setDelayedMimeTypes()

void KFileItem::setDelayedMimeTypes ( bool b )

Sets MIME type determination to be immediate or on demand.

Call this after the constructor, and before using any MIME-type-related method.

Since: 5.0

Definition at line 646 of file kfileitem.cpp.

◆ setLocalPath()

void KFileItem::setLocalPath ( const QString & path )

Sets the item's local path (UDS_LOCAL_PATH).

Do not call unless you know what you are doing! This won't change the item's name or URL. (used for example when an item got renamed).

Parameters

path	the item's local path

Since: 5.20

Definition at line 665 of file kfileitem.cpp.

◆ setName()

void KFileItem::setName ( const QString & name )

Sets the item's name (i.e. the filename).

This is automatically done by setUrl, to set the name from the URL's fileName(). This method is provided for some special cases like relative paths as names (KFindPart)

Parameters

name	the item's name

Definition at line 675 of file kfileitem.cpp.

◆ setUrl()

void KFileItem::setUrl ( const QUrl & url )

Sets the item's URL.

Do not call unless you know what you are doing! (used for example when an item got renamed).

Parameters

url	the item's URL

Definition at line 654 of file kfileitem.cpp.

◆ size()

KIO::filesize_t KFileItem::size ( ) const

Returns the size of the file, if known.

Returns: the file size, or 0 if not known

Definition at line 735 of file kfileitem.cpp.

◆ targetUrl()

QUrl KFileItem::targetUrl ( ) const

Returns the target url of the file, which is the same as url() in cases where the worker doesn't specify UDS_TARGET_URL.

Returns: the target url.

Since: 4.1

◆ text()

QString KFileItem::text ( ) const

Returns the text of the file item.

It's not exactly the filename since some decoding happens ('%2F'->'/').

Returns: the text of the file item

◆ time()

QDateTime KFileItem::time ( FileTimes which ) const

Requests the modification, access or creation time, depending on which.

Parameters

which the timestamp

Returns: the time asked for, QDateTime() if not available

See also: timeString()

Definition at line 796 of file kfileitem.cpp.

◆ timeString()

QString KFileItem::timeString ( FileTimes which = ModificationTime ) const

Requests the modification, access or creation time as a string, depending on which.

Parameters

which the timestamp

Returns: a formatted string of the requested time.

See also: time

Definition at line 1447 of file kfileitem.cpp.

◆ url()

QUrl KFileItem::url ( ) const

Returns the url of the file.

Returns: the url of the file

◆ user()

QString KFileItem::user ( ) const

Returns the owner of the file.

Returns: the file's owner

The documentation for this class was generated from the following files:

QUrl

KFileItem::mostLocalUrl

QUrl mostLocalUrl(bool *local=nullptr) const

Tries to return a local URL for this file item if possible.

Definition: kfileitem.cpp:1482

KFileItem

Definition: kfileitem.h:35

KFileItem::isMostLocalUrl

MostLocalUrlResult isMostLocalUrl() const

Returns a MostLocalUrlResult, with the local Url for this item if possible (otherwise an empty Url),...

Definition: kfileitem.cpp:1495

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KIO

KFileItem

Public Types

Properties

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ FileTimes

Constructor & Destructor Documentation

◆ KFileItem() [1/7]

◆ KFileItem() [2/7]

◆ KFileItem() [3/7]

◆ KFileItem() [4/7]

◆ KFileItem() [5/7]

◆ KFileItem() [6/7]

◆ ~KFileItem()

◆ KFileItem() [7/7]

Member Function Documentation

◆ acceptsDrops()

◆ ACL()

◆ assign()

◆ cmp()

◆ comment()

◆ currentMimeType()

◆ defaultACL()

◆ determineMimeType()

◆ entry()

◆ getStatusBarInfo()

◆ group()

◆ hasExtendedACL()

◆ iconName()

◆ isDesktopFile()

◆ isDir()

◆ isFile()

◆ isFinalIconKnown()

◆ isHidden()

◆ isLink()

◆ isLocalFile()

◆ isMimeTypeKnown()

◆ isMostLocalUrl()

◆ isNull()

◆ isReadable()

◆ isRegularFile()

◆ isSlow()

◆ isWritable()

◆ linkDest()

◆ localPath()

◆ mimeComment()

◆ mimetype()

◆ mode()

◆ mostLocalUrl() [1/2]

◆ mostLocalUrl() [2/2]

◆ name()

◆ operator QVariant()

◆ operator!=()

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ overlays()

◆ permissions()

◆ permissionsString()

◆ recursiveSize()

◆ refresh()

◆ refreshMimeType()

◆ setDelayedMimeTypes()

◆ setLocalPath()

◆ setName()

◆ setUrl()

◆ size()

◆ targetUrl()

◆ text()

◆ time()

◆ timeString()

◆ url()

◆ user()