FileIconProvider

Qt Base Class: QFileIconProvider

Signature: QFileIconProvider(self) -> None

Base classes

Name	Children	Inherits
AbstractFileIconProviderMixin prettyqt.gui.abstractfileiconprovider	AbstractFileIconProvider FileIconProvider	object
QFileIconProvider PySide6.QtWidgets QFileIconProvider(self) -> None	FileIconProvider	QAbstractFileIconProvider

⋔ Inheritance diagram

graph TD
  1473296199280["widgets.FileIconProvider"]
  1473245651936["gui.AbstractFileIconProviderMixin"]
  140713234304496["builtins.object"]
  1473290824304["QtWidgets.QFileIconProvider"]
  1473299927184["QtGui.QAbstractFileIconProvider"]
  1473291690208["Shiboken.Object"]
  1473245651936 --> 1473296199280
  140713234304496 --> 1473245651936
  1473290824304 --> 1473296199280
  1473299927184 --> 1473290824304
  1473291690208 --> 1473299927184
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: AbstractFileIconProviderMixin, QFileIconProvider

File icons for the QFileSystemModel class.

Source code in prettyqt\widgets\fileiconprovider.py

class FileIconProvider(gui.AbstractFileIconProviderMixin, QtWidgets.QFileIconProvider):
    """File icons for the QFileSystemModel class."""

    def get_icon(
        self,
        typ: gui.abstractfileiconprovider.IconTypeStr
        | core.QFileInfo
        | datatypes.PathType,
    ) -> gui.QIcon:
        if isinstance(typ, os.PathLike | core.QFileInfo):
            param = core.FileInfo(typ)
        else:
            param = gui.abstractfileiconprovider.ICON_TYPE[typ]
        return self.icon(param)

    def use_custom_directory_icons(self, state: bool = True):
        opt = self.Option(0) if state else self.Option.DontUseCustomDirectoryIcons
        self.setOptions(opt)

    def uses_custom_directory_icons(self) -> bool:
        return self.options() == self.Option(0)