#[repr(C)]pub struct QMimeType { /* private fields */ }
Expand description
The QMimeType class describes types of file or data, represented by a MIME type string.
C++ class: QMimeType
.
The QMimeType class describes types of file or data, represented by a MIME type string.
For instance a file named "readme.txt" has the MIME type "text/plain". The MIME type can be determined from the file name, or from the file contents, or from both. MIME type determination can also be done on buffers of data not coming from files.
Determining the MIME type of a file can be useful to make sure your application supports it. It is also useful in file-manager-like applications or widgets, in order to display an appropriate icon for the file, or even the descriptive comment in detailed views.
To check if a file has the expected MIME type, you should use inherits() rather than a simple string comparison based on the name(). This is because MIME types can inherit from each other: for instance a C source file is a specific type of plain text file, so text/x-csrc inherits text/plain.
Implementations§
source§impl QMimeType
impl QMimeType
sourcepub unsafe fn aliases(&self) -> CppBox<QStringList>
pub unsafe fn aliases(&self) -> CppBox<QStringList>
Return the list of aliases of this mimetype.
Calls C++ function: QStringList QMimeType::aliases() const
.
Return 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.
sourcepub unsafe fn all_ancestors(&self) -> CppBox<QStringList>
pub unsafe fn all_ancestors(&self) -> CppBox<QStringList>
Return all the parent mimetypes of this mimetype, direct and indirect. This includes the parent(s) of its parent(s), etc.
Calls C++ function: QStringList QMimeType::allAncestors() const
.
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).
sourcepub unsafe fn comment(&self) -> CppBox<QString>
pub unsafe fn comment(&self) -> CppBox<QString>
Returns the description of the MIME type to be displayed on user interfaces.
Calls C++ function: QString QMimeType::comment() const
.
Returns the description of the MIME type to be displayed on user interfaces.
The default language (QLocale().name()) is used to select the appropriate translation.
sourcepub unsafe fn copy_from(
&self,
other: impl CastInto<Ref<QMimeType>>
) -> Ref<QMimeType>
pub unsafe fn copy_from( &self, other: impl CastInto<Ref<QMimeType>> ) -> Ref<QMimeType>
sourcepub unsafe fn filter_string(&self) -> CppBox<QString>
pub unsafe fn filter_string(&self) -> CppBox<QString>
Returns a filter string usable for a file dialog.
Calls C++ function: QString QMimeType::filterString() const
.
Returns a filter string usable for a file dialog.
sourcepub unsafe fn generic_icon_name(&self) -> CppBox<QString>
pub unsafe fn generic_icon_name(&self) -> CppBox<QString>
Returns the file name of a generic icon that represents the MIME type.
Calls C++ function: QString QMimeType::genericIconName() const
.
Returns 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.
sourcepub unsafe fn glob_patterns(&self) -> CppBox<QStringList>
pub unsafe fn glob_patterns(&self) -> CppBox<QStringList>
Returns the list of glob matching patterns.
Calls C++ function: QStringList QMimeType::globPatterns() const
.
Returns the list of glob matching patterns.
sourcepub unsafe fn icon_name(&self) -> CppBox<QString>
pub unsafe fn icon_name(&self) -> CppBox<QString>
Returns the file name of an icon image that represents the MIME type.
Calls C++ function: QString QMimeType::iconName() const
.
Returns 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.
sourcepub unsafe fn inherits(
&self,
mime_type_name: impl CastInto<Ref<QString>>
) -> bool
pub unsafe fn inherits( &self, mime_type_name: impl CastInto<Ref<QString>> ) -> bool
Returns true
if this mimetype is mimeTypeName, or inherits mimeTypeName (see parentMimeTypes()), or mimeTypeName is an alias for this mimetype.
Calls C++ function: 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.
sourcepub unsafe fn is_default(&self) -> bool
pub unsafe fn is_default(&self) -> bool
Returns true
if this MIME type is the default MIME type which applies to all files: application/octet-stream.
Calls C++ function: bool QMimeType::isDefault() const
.
Returns true
if this MIME type is the default MIME type which applies to all files: application/octet-stream.
sourcepub unsafe fn is_valid(&self) -> bool
pub unsafe fn is_valid(&self) -> bool
sourcepub unsafe fn name(&self) -> CppBox<QString>
pub unsafe fn name(&self) -> CppBox<QString>
Returns the name of the MIME type.
Calls C++ function: QString QMimeType::name() const
.
Returns the name of the MIME type.
sourcepub unsafe fn new() -> CppBox<QMimeType>
pub unsafe fn new() -> CppBox<QMimeType>
sourcepub unsafe fn new_copy(
other: impl CastInto<Ref<QMimeType>>
) -> CppBox<QMimeType>
pub unsafe fn new_copy( other: impl CastInto<Ref<QMimeType>> ) -> CppBox<QMimeType>
sourcepub unsafe fn parent_mime_types(&self) -> CppBox<QStringList>
pub unsafe fn parent_mime_types(&self) -> CppBox<QStringList>
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.
Calls C++ function: QStringList QMimeType::parentMimeTypes() const
.
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.
sourcepub unsafe fn preferred_suffix(&self) -> CppBox<QString>
pub unsafe fn preferred_suffix(&self) -> CppBox<QString>
Returns 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.
Calls C++ function: QString QMimeType::preferredSuffix() const
.
Returns 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.
sourcepub unsafe fn static_meta_object() -> Ref<QMetaObject>
Available on cpp_lib_version="5.11.3"
or cpp_lib_version="5.12.2"
or cpp_lib_version="5.13.0"
or cpp_lib_version="5.14.0"
only.
pub unsafe fn static_meta_object() -> Ref<QMetaObject>
cpp_lib_version="5.11.3"
or cpp_lib_version="5.12.2"
or cpp_lib_version="5.13.0"
or cpp_lib_version="5.14.0"
only.Returns a reference to the staticMetaObject
field.
sourcepub unsafe fn suffixes(&self) -> CppBox<QStringList>
pub unsafe fn suffixes(&self) -> CppBox<QStringList>
Returns the known suffixes for the MIME type. No leading dot is included, so for instance this would return "jpg", "jpeg" for image/jpeg.
Calls C++ function: QStringList QMimeType::suffixes() const
.
Returns the known suffixes for the MIME type. No leading dot is included, so for instance this would return “jpg”, “jpeg” for image/jpeg.
sourcepub unsafe fn swap(&self, other: impl CastInto<Ref<QMimeType>>)
pub unsafe fn swap(&self, other: impl CastInto<Ref<QMimeType>>)
Swaps QMimeType other with this QMimeType object.
Calls C++ function: void QMimeType::swap(QMimeType& other)
.
Swaps QMimeType other with this QMimeType object.
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.
Trait Implementations§
source§impl CppDeletable for QMimeType
impl CppDeletable for QMimeType
source§impl PartialEq<Ref<QMimeType>> for QMimeType
impl PartialEq<Ref<QMimeType>> for QMimeType
source§fn eq(&self, other: &Ref<QMimeType>) -> bool
fn eq(&self, other: &Ref<QMimeType>) -> bool
Returns true
if other equals this QMimeType object, otherwise returns false
. The name is the unique identifier for a mimetype, so two mimetypes with the same name, are equal.
Calls C++ function: bool QMimeType::operator==(const QMimeType& other) const
.
Returns true
if other equals this QMimeType object, otherwise returns false
. The name is the unique identifier for a mimetype, so two mimetypes with the same name, are equal.