Класс QMimeDatabase

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

Этот класс был представлен в Qt 5.0.

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

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

Типы 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 приведет к тому, что будет произведен поиск определений MIME в /opt/myapp/share/mime/packages/.

Вот пример 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 или некорректный, если тип MIME не найден.

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.