QMimeType Class | Qt Core (original) (raw)

The QMimeType class describes types of file or data, represented by a MIME type string. More...

This class is equality-comparable.

Property Documentation

[read-only] aliases : const QStringList

This property holds the list of aliases of this mimetype

For instance, for text/csv, the returned list would be: text/x-csv, text/x-comma-separated-values.

Note that all QMimeType instances refer to proper mimetypes, never to aliases directly.

The order of the aliases in the list is undefined.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] allAncestors : const QStringList

This property holds the names of direct and indirect parent MIME types

Return all the parent mimetypes of this mimetype, direct and indirect. This includes the parent(s) of its parent(s), etc.

For instance, for image/svg+xml the list would be: application/xml, text/plain, application/octet-stream.

Note that application/octet-stream is the ultimate parent for all types of files (but not directories).

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] comment : const QString

This property holds the description of the MIME type to be displayed on user interfaces

Returns a description for a MIME type, localized to the user's current language settings.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] filterString : const QString

This property holds a filter string usable for a file dialog

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] genericIconName : const QString

This property holds the file name of a generic icon that represents the MIME type

This should be used if the icon returned by iconName() cannot be found on the system. It is used for categories of similar types (like spreadsheets or archives) that can use a common icon. The freedesktop.org Icon Naming Specification lists a set of such icon names.

The icon name can be given to QIcon::fromTheme() in order to load the icon.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] globPatterns : const QStringList

This property holds the list of glob matching patterns

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] iconName : const QString

This property holds the file name of an icon image that represents the MIME type

The icon name can be given to QIcon::fromTheme() in order to load the icon.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] isDefault : const bool

true if this MIME type is the default MIME type which applies to all files: application/octet-stream.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] name : const QString

This property holds the name of the MIME type

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] parentMimeTypes : const QStringList

This property holds the names of parent MIME types

A type is a subclass of another type if any instance of the first type is also an instance of the second. For example, all image/svg+xml files are also text/xml, text/plain and application/octet-stream files. Subclassing is about the format, rather than the category of the data (for example, there is no 'generic spreadsheet' class that all spreadsheets inherit from). Conversely, the parent mimetype of image/svg+xml is text/xml.

A mimetype can have multiple parents. For instance application/x-perl has two parents: application/x-executable and text/plain. This makes it possible to both execute perl scripts, and to open them in text editors.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] preferredSuffix : const QString

This property holds the preferred suffix for the MIME type

No leading dot is included, so for instance this would return "pdf" for application/pdf. The return value can be empty, for mime types which do not have any suffixes associated.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] suffixes : const QStringList

This property holds the known suffixes for the MIME type

No leading dot is included, so for instance this would return "jpg", "jpeg" for image/jpeg.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

[read-only] valid : const bool

true if the QMimeType object contains valid data, false otherwise

A valid MIME type has a non-empty name(). The invalid MIME type is the default-constructed QMimeType.

While this property was introduced in 5.10, the corresponding accessor method has always been there.

Access functions:

Member Function Documentation

QMimeType::QMimeType()

Constructs this QMimeType object initialized with default property values that indicate an invalid MIME type.

QMimeType::QMimeType(const QMimeType &other)

Constructs this QMimeType object as a copy of other.

[noexcept] QMimeType::~QMimeType()

Destroys the QMimeType object, and releases the d pointer.

[invokable] bool QMimeType::inherits(const QString &mimeTypeName) const

Returns true if this mimetype is mimeTypeName, or inherits mimeTypeName (see parentMimeTypes()), or mimeTypeName is an alias for this mimetype.

This method has been made invokable from QML since 5.10.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[noexcept] void QMimeType::swap(QMimeType &other)

Swaps this mime type with other. This operation is very fast and never fails.

The swap() method helps with the implementation of assignment operators in an exception-safe way. For more information consult More C++ Idioms - Copy-and-swap.

[noexcept] QMimeType &QMimeType::operator=(QMimeType &&other)

Move-assigns other to this QMimeType instance.

QMimeType &QMimeType::operator=(const QMimeType &other)

Assigns the data of other to this QMimeType object, and returns a reference to this object.