Класс QMimeDatabase

Класс QMimeDatabase поддерживает базу данных типов MIME. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются безопасными для потоков.

Типы public

Функции public

Подробное описание

База данных типов MIME предоставляется проектом freedesktop.org shared-mime-info. Если база данных типов MIME не может быть найдена в системе, как это происходит в большинстве систем Windows, macOS и iOS, Qt будет использовать свою собственную копию.

Приложения, которые хотят определить пользовательские типы MIME, должны установить XML-файл в места, которые ищутся определениями MIME. Эти места можно запросить с помощью

QStandardPaths::locateAll(QStandardPaths::GenericDataLocation, QLatin1String("mime/packages"),
                          QStandardPaths::LocateDirectory);

В типичной Unix-системе это будет /usr/share/mime/packages/, но также можно расширить список директорий, установив переменную окружения XDG_DATA_DIRS. Например, добавление /opt/myapp/share к XDG_DATA_DIRS приведет к тому, что /opt/myapp/share/mime/packages/ будет проверяться на наличие определений MIME.

Вот пример XML MIME:

<?xml version="1.0" encoding="UTF-8"?>
<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info">
  <mime-type type="application/vnd.qt.qmakeprofile">
    <comment xml:lang="en">Qt qmake Profile</comment>
    <glob pattern="*.pro" weight="50"/>
  </mime-type>
</mime-info>

Для получения более подробной информации о синтаксисе XML-определений MIME, включая определение «магии» для обнаружения типов MIME на основе данных, ознакомьтесь со спецификацией Shared Mime Info по адресу http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html

В системах Unix используется двоичный кеш для повышения производительности. Этот кеш генерируется командой «update-mime-database path», где путь будет /opt/myapp/share/mime в приведенном выше примере. Убедитесь, что вы запускаете эту команду при установке файла определения типа MIME.

QMimeDatabase db;
QMimeType mime = db.mimeTypeForFile(fileName);
if (mime.inherits("text/plain")) {
    // The file is plain text, we can display it in a QTextEdit
}

См. также QMimeType и Пример обозревателя типов MIME.

Документация по типам членов

Перечисление QMimeDatabase::MatchMode

Это перечисление определяет, как выполняется сопоставление файла с типом MIME.

Документация по функциям-членам

QMimeDatabase::QMimeDatabase()

Конструирует объект QMimeDatabase.

Создание экземпляра QMimeDatabase каждый раз, когда вам нужен поиск, вполне допустимо. Разбор типов MIME выполняется по мере необходимости (при установке shared-mime-info) или при построении первого экземпляра (при разборе XML-файлов напрямую).

QMimeDatabase::~QMimeDatabase()

Уничтожает объект QMimeDatabase.

QList<QMimeType> QMimeDatabase::allMimeTypes() const

Возвращает список всех доступных типов MIME.

Это может быть полезно для отображения всех типов MIME пользователю, например, в редакторе типов MIME. Однако не используйте, если это не действительно необходимо в других случаях, предпочитайте использовать методы mimeTypeForXxx() по соображениям производительности.

QMimeType QMimeDatabase::mimeTypeForData(const QByteArray &data) const

Возвращает тип MIME для data.

Всегда возвращается допустимый тип MIME. Если data не соответствует ни одному известному типу MIME, возвращается тип MIME по умолчанию (application/octet-stream).

QMimeType QMimeDatabase::mimeTypeForData(QIODevice *device) const

Возвращает тип MIME для данных в device.

Всегда возвращается допустимый тип MIME. Если данные в device не соответствуют ни одному известному типу MIME, возвращается тип MIME по умолчанию (application/octet-stream).

QMimeType QMimeDatabase::mimeTypeForFile(const QFileInfo &fileInfo, QMimeDatabase::MatchMode mode = MatchDefault) const

Возвращает тип MIME для fileInfo.

Всегда возвращается допустимый тип MIME.

Алгоритм сопоставления по умолчанию учитывает как имя файла, так и содержимое файла, если это необходимо. Расширение файла имеет приоритет над содержимым, но содержимое будет использоваться, если расширение файла неизвестно или соответствует нескольким типам MIME. Если fileInfo — это Unix-символическая ссылка, вместо нее будет использоваться файл, на который она ссылается. Если файл не соответствует ни одному известному шаблону или данным, возвращается тип MIME по умолчанию (application/octet-stream).

Когда mode установлен в MatchExtension, используется только имя файла, а не содержимое файла. Файл даже не обязательно должен существовать. Если имя файла не соответствует ни одному известному шаблону, возвращается тип MIME по умолчанию (application/octet-stream). Если нескольким типам MIME соответствует этот файл, возвращается первый из них (в алфавитном порядке).

Когда mode установлен в MatchContent, и файл читабелен, для определения типа MIME используется только содержимое файла. Это эквивалентно вызову mimeTypeForData с QFile в качестве входного устройства.

fileInfo может ссылаться на абсолютный или относительный путь.

См. также QMimeType::isDefault() и mimeTypeForData().

QMimeType QMimeDatabase::mimeTypeForFile(const QString &fileName, QMimeDatabase::MatchMode mode = MatchDefault) const

Возвращает тип MIME для файла с именем fileName, используя mode.

Это перегруженная функция.

QMimeType QMimeDatabase::mimeTypeForFileNameAndData(const QString &fileName, QIODevice *device) const

Возвращает тип MIME для заданного fileName и данных device.

Этот перегруз может быть полезен, когда файл удалённый, и мы начали загружать часть его данных на устройство. Это позволяет выполнять полное сопоставление типа MIME для удалённых файлов.

Если устройство не открыто, оно будет открыто этой функцией и закрыто после завершения определения типа MIME.

Всегда возвращается допустимый тип MIME. Если данные device не соответствуют ни одному известному типу MIME, возвращается тип MIME по умолчанию (application/octet-stream).

Этот метод анализирует и имя файла, и содержимое файла, если это необходимо. Расширение файла имеет приоритет над содержимым, но содержимое будет использовано, если расширение файла неизвестно или соответствует нескольким типам MIME.

QMimeType QMimeDatabase::mimeTypeForFileNameAndData(const QString &fileName, const QByteArray &data) const

Возвращает тип MIME для заданного fileName и данных устройства data.

Этот перегруз может быть полезен, когда файл удалённый, и мы начали загружать часть его данных. Это позволяет выполнять полное сопоставление типа MIME для удалённых файлов.

Всегда возвращается допустимый тип MIME. Если данные data не соответствуют ни одному известному типу MIME, возвращается тип MIME по умолчанию (application/octet-stream).

Этот метод анализирует и имя файла, и содержимое файла, если это необходимо. Расширение файла имеет приоритет над содержимым, но содержимое будет использовано, если расширение файла неизвестно или соответствует нескольким типам MIME.

QMimeType QMimeDatabase::mimeTypeForName(const QString &nameOrAlias) const

Возвращает тип MIME для nameOrAlias или недопустимый тип, если таковой не найден.

QMimeType QMimeDatabase::mimeTypeForUrl(const QUrl &url) const

Возвращает тип MIME для url.

Если URL указывает на локальный файл, это вызывает mimeTypeForFile.

В противном случае сопоставление выполняется только по имени файла, за исключением схем, где имена файлов не имеют большого значения, например, HTTP. Этот метод всегда возвращает тип MIME по умолчанию для HTTP-URL, используйте QNetworkAccessManager для правильной обработки HTTP-URL.

Всегда возвращается допустимый тип MIME. Если url не соответствует никакому известному типу MIME, возвращается тип MIME по умолчанию (application/octet-stream).

QList<QMimeType> QMimeDatabase::mimeTypesForFileName(const QString &fileName) const

Возвращает типы MIME для имени файла fileName.

Если имя файла не соответствует никакому известному шаблону, возвращается пустой список. Если нескольким типам MIME соответствует этот файл, они все возвращаются.

Эта функция не пытается открыть файл. Для использования содержимого при определении типа MIME используйте mimeTypeForFile() или mimeTypeForFileNameAndData() вместо этого.

См. также mimeTypeForFile().

QString QMimeDatabase::suffixForFileName(const QString &fileName) const

Возвращает суффикс для файла fileName, как известно базе данных MIME.

Это позволяет предварительно выбрать «tar.bz2» для foo.tar.bz2, но всё ещё только «txt» для my.file.with.dots.txt.