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 }
 

Public Member Functions

 KFileItem ()
 
 KFileItem (const KIO::UDSEntry &entry, const QUrl &itemOrDirUrl, bool delayedMimeTypes=false, bool urlIsDirectory=false)
 
 KFileItem (mode_t mode, mode_t permissions, const QUrl &url, bool delayedMimeTypes=false)
 
 KFileItem (const QUrl &url, const QString &mimeType=QString(), mode_t mode=KFileItem::Unknown)
 
 KFileItem (const QUrl &url, KFileItem::MimeTypeDetermination mimeTypeDetermination)
 
 KFileItem (const KFileItem &)
 
 KFileItem (KFileItem &&)
 
 ~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
 
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=nullptr) const
 
QUrl mostLocalUrl (bool &local) 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
 
KFileItemoperator= (const KFileItem &)
 
KFileItemoperator= (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
 
QDateTime time (FileTimes which) const
 
QString timeString (FileTimes which=ModificationTime) const
 
QString timeString (unsigned int which) const
 
QUrl url () const
 
QString user () const
 

Friends

KIOCORE_EXPORT friend QDataStreamoperator<< (QDataStream &s, const KFileItem &a)
 
KIOCORE_EXPORT friend QDataStreamoperator>> (QDataStream &s, KFileItem &a)
 

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 mimetype, 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 47 of file kfileitem.h.

Member Enumeration Documentation

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 58 of file kfileitem.h.

Constructor & Destructor Documentation

KFileItem::KFileItem ( )

Null KFileItem.

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

Definition at line 522 of file kfileitem.cpp.

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
entrythe KIO entry used to get the file, contains info about it
itemOrDirUrlthe URL of the item or of the directory containing this item (see urlIsDirectory).
delayedMimeTypesspecifies if the mimetype of the given URL should be determined immediately or on demand. See the bool delayedMimeTypes in the KDirLister constructor.
urlIsDirectoryspecifies 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 527 of file kfileitem.cpp.

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
modethe file mode (according to stat() (e.g. S_IFDIR...) Set to KFileItem::Unknown if unknown. For local files, KFileItem will use stat().
permissionsthe 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.
urlthe file url
delayedMimeTypesspecify if the mimetype 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 534 of file kfileitem.cpp.

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

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

Parameters
urlthe file url
mimeTypethe name of the file's mimetype
modethe mode (S_IFDIR...)

Definition at line 541 of file kfileitem.cpp.

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

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

Parameters
urlthe file url
mimeTypeDeterminationthe 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 552 of file kfileitem.cpp.

KFileItem::KFileItem ( const KFileItem )
default

Copy constructor.

KFileItem::~KFileItem ( )
default

Destructor.

KFileItem::KFileItem ( KFileItem &&  )
default

Move constructor.

Since
5.43

Member Function Documentation

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 1271 of file kfileitem.cpp.

KACL KFileItem::ACL ( ) const

Returns the access control list for the file.

Returns
the access control list as a KACL

Definition at line 721 of file kfileitem.cpp.

void KFileItem::assign ( const KFileItem item)
Deprecated:
Since 4.0, simply use '='

Definition at line 1422 of file kfileitem.cpp.

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
itemthe item to compare
Returns
true if all values are equal

Definition at line 1322 of file kfileitem.cpp.

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

Definition at line 1138 of file kfileitem.cpp.

QMimeType KFileItem::currentMimeType ( ) const

Returns the currently known mimetype of the file item.

This will not try to determine the mimetype if unknown.

Returns
the known mime type

Definition at line 1594 of file kfileitem.cpp.

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 739 of file kfileitem.cpp.

QMimeType KFileItem::determineMimeType ( ) const

Returns the mimetype of the file item.

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

Returns
the mime type

Definition at line 814 of file kfileitem.cpp.

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 1628 of file kfileitem.cpp.

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

Definition at line 1296 of file kfileitem.cpp.

QString KFileItem::group ( ) const

Returns the group of the file.

Returns
the file's group

Definition at line 772 of file kfileitem.cpp.

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 711 of file kfileitem.cpp.

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

Definition at line 988 of file kfileitem.cpp.

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

Definition at line 1699 of file kfileitem.cpp.

bool KFileItem::isDir ( ) const

Returns true if this item represents a directory.

Returns
true if the item is a directory

Definition at line 1241 of file kfileitem.cpp.

bool KFileItem::isFile ( ) const

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

Returns
true if the item is a file

Definition at line 1261 of file kfileitem.cpp.

bool KFileItem::isFinalIconKnown ( ) const
Returns
true if we have determined the final icon of this file already.
Since
4.10.2

Definition at line 876 of file kfileitem.cpp.

bool KFileItem::isHidden ( ) const

Checks whether the file is hidden.

Returns
true if the file is hidden.

Definition at line 1215 of file kfileitem.cpp.

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

Definition at line 1525 of file kfileitem.cpp.

bool KFileItem::isLocalFile ( ) const

Returns true if the file is a local file.

Returns
true if the file is local, false otherwise

Definition at line 1536 of file kfileitem.cpp.

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

Definition at line 846 of file kfileitem.cpp.

bool KFileItem::isNull ( ) const

Return true if default-constructed.

Definition at line 1639 of file kfileitem.cpp.

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

Definition at line 1147 of file kfileitem.cpp.

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

Definition at line 1704 of file kfileitem.cpp.

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

Definition at line 795 of file kfileitem.cpp.

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

Definition at line 1184 of file kfileitem.cpp.

QString KFileItem::linkDest ( ) const

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

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

Definition at line 651 of file kfileitem.cpp.

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

Definition at line 684 of file kfileitem.cpp.

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

Definition at line 885 of file kfileitem.cpp.

QString KFileItem::mimetype ( ) const

Returns the mimetype of the file item.

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

Returns
the mime type of the file

Definition at line 804 of file kfileitem.cpp.

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 1514 of file kfileitem.cpp.

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

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

The given boolean indicates if the returned url is local or not.

Since
4.6

Definition at line 1428 of file kfileitem.cpp.

QUrl KFileItem::mostLocalUrl ( bool &  local) const
inline
Deprecated:
since 5.0 add '&' in front of your boolean argument

Definition at line 561 of file kfileitem.h.

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
lowerCaseif 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 1554 of file kfileitem.cpp.

KFileItem::operator QVariant ( ) const

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

Definition at line 1372 of file kfileitem.cpp.

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

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

Definition at line 1348 of file kfileitem.cpp.

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 1353 of file kfileitem.cpp.

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 1364 of file kfileitem.cpp.

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

Copy assignment.

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

Move assignment.

Since
5.43
bool KFileItem::operator== ( const KFileItem other) const

Returns true if both items share the same URL.

Definition at line 1335 of file kfileitem.cpp.

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

Definition at line 1075 of file kfileitem.cpp.

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 1503 of file kfileitem.cpp.

QString KFileItem::permissionsString ( ) const

Returns the access permissions for the file as a string.

Returns
the access permission as string

Definition at line 1377 of file kfileitem.cpp.

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 702 of file kfileitem.cpp.

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 572 of file kfileitem.cpp.

void KFileItem::refreshMimeType ( )

Re-reads mimetype information.

This is called when the mimetype database changes.

Definition at line 592 of file kfileitem.cpp.

void KFileItem::setDelayedMimeTypes ( bool  b)

Sets mimetype determination to be immediate or on demand.

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

Since
5.0

Definition at line 603 of file kfileitem.cpp.

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
paththe item's local path
Since
5.20

Definition at line 622 of file kfileitem.cpp.

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
namethe item's name

Definition at line 632 of file kfileitem.cpp.

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
urlthe item's URL

Definition at line 611 of file kfileitem.cpp.

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 693 of file kfileitem.cpp.

QUrl KFileItem::targetUrl ( ) const

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

Returns
the target url.
Since
4.1

Definition at line 1568 of file kfileitem.cpp.

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

Definition at line 1545 of file kfileitem.cpp.

QDateTime KFileItem::time ( FileTimes  which) const

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

Parameters
whichthe timestamp
Returns
the time asked for, QDateTime() if not available
See also
timeString()

Definition at line 754 of file kfileitem.cpp.

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

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

Parameters
whichthe timestamp
Returns
a formatted string of the requested time.
See also
time

Definition at line 1393 of file kfileitem.cpp.

QUrl KFileItem::url ( ) const

Returns the url of the file.

Returns
the url of the file

Definition at line 1494 of file kfileitem.cpp.

QString KFileItem::user ( ) const

Returns the owner of the file.

Returns
the file's owner

Definition at line 763 of file kfileitem.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jul 2 2020 22:59:09 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.