Member Function Documentation

[explicit] KDirModel::KDirModel(QObject *parent = nullptr)

@param parent parent qobject

[invokable] void KDirModel::clearAllPreviews()

Forget all previews (optimization for turning previews off). The items will again have their default appearance (not controlled by the model). @since 5.28

KDirLister *KDirModel::dirLister() const

Return the directory lister used by this model.

See also setDirLister().

[signal] void KDirModel::expand(const QModelIndex &index)

Emitted for each subdirectory that is a parent of a url passed to expandToUrl This allows to asynchronously open a tree view down to a given directory. Also emitted for the final file, if expandToUrl is called with a file (for instance so that it can be selected).

[invokable] void KDirModel::expandToUrl(const QUrl &url)

@short Lists subdirectories using fetchMore() as needed until the given @p url exists in the model.

When the model is used by a treeview, call KDirLister::openUrl with the base url of the tree, then the treeview will take care of calling fetchMore() when the user opens directories. However if you want the tree to show a given URL (i.e. open the tree recursively until that URL), call expandToUrl(). Note that this is asynchronous; the necessary listing of subdirectories will take time so the model will not immediately have this url available. The model emits the signal expand() when an index has become available; this can be connected to the treeview in order to let it open that index. @param url the url of a subdirectory of the directory model (or a file in a subdirectory)

[invokable] QModelIndex KDirModel::indexForItem(const KFileItem &) const

Return the index for a given kfileitem. This can be slow.

[invokable] QModelIndex KDirModel::indexForUrl(const QUrl &url) const

Return the index for a given url. This can be slow.

[invokable] void KDirModel::itemChanged(const QModelIndex &index)

Notify the model that the item at this index has changed. For instance because KMimeTypeResolver called determineMimeType on it. This makes the model emit its dataChanged signal at this index, so that views repaint. Note that for most things (renaming, changing size etc.), KDirLister's signals tell the model already.

KFileItem KDirModel::itemForIndex(const QModelIndex &index) const

Return the fileitem for a given index. This is O(1), i.e. fast.

bool KDirModel::jobTransfersVisible() const

Returns whether or not displaying job transfers has been enabled.

See also setJobTransfersVisible().

[signal] void KDirModel::needSequenceIcon(const QModelIndex &index, int sequenceIndex)

Emitted when another icon sequence index is requested @param index Index of the item that should get another icon @param sequenceIndex Index in the sequence. If it is zero, the standard icon should be assigned. For higher indices, arbitrary different meaningful icons should be generated. This is usually slowly counted up while the user hovers the icon. If no meaningful alternative icons can be generated, this should be ignored.

[invokable] void KDirModel::openUrl(const QUrl &url, KDirModel::OpenUrlFlags flags = NoFlags)

Display the contents of @p url in the model. Apart from the support for the ShowRoot flag, this is equivalent to dirLister()->openUrl(url, flags) @param url the URL of the directory whose contents should be listed. Unless ShowRoot is set, the item for this directory will NOT be shown, the model starts at its children. @param flags see OpenUrlFlag @since 5.69

void KDirModel::requestSequenceIcon(const QModelIndex &index, int sequenceIndex)

This emits the needSequenceIcon signal, requesting another sequence icon

If there is a KFilePreviewGenerator attached to this model, that generator will care about creating another preview.

@param index Index of the item that should get another icon @param sequenceIndex Index in the sequence. If it is zero, the standard icon will be assigned. For higher indices, arbitrary different meaningful icons will be generated.

void KDirModel::setDirLister(KDirLister *dirLister)

Set the directory lister to use by this model, instead of the default KDirLister created internally. The model takes ownership.

See also dirLister().

void KDirModel::setJobTransfersVisible(bool show)

Enable/Disable the displaying of an animated overlay that is shown for any destination urls (in the view). When enabled, the animations (if any) will be drawn automatically.

Only the files/folders that are visible and have jobs associated with them will display the animation. You would likely not want this enabled if you perform some kind of custom painting that takes up a whole item, and will just make this(and what you paint) look funky.

Default is disabled.

Note: KFileItemDelegate needs to have it's method called with the same value, when you make the call to this method.

See also jobTransfersVisible().

[static] QList<QUrl> KDirModel::simplifiedUrlList(const QList<QUrl> &urls)

Remove urls from the list if an ancestor is present on the list. This can be used to delete only the ancestor url and skip a potential error of a non-existent url.

For example, for a list of "/home/foo/a", "/home/foo/a/a.txt", "/home/foo/a/a/a.txt", "/home/foo/a/b/b.txt", "home/foo/b/b.txt", this method will return the list "/home/foo/a", "/home/foo/b/b.txt".

@return the list @p urls without parented urls inside.