Simple value type class that encapsulates MIME type data.
More...
|
None | __init__ (self, str name, str comment, Optional[List[str]] suffixes, str preferred_suffix=None) |
| Constructor. More...
|
|
str | name (self) |
| The name that identifies the MIME type. More...
|
|
str | comment (self) |
| The comment that describes of the MIME type. More...
|
|
List[str] | suffixes (self) |
| The list of file name suffixes for the MIME type. More...
|
|
str | preferredSuffix (self) |
| The preferred file name suffix for the MIME type. More...
|
|
str | __repr__ (self) |
| Gives a programmer-readable representation of the MIME type. More...
|
|
bool | __eq__ (self, object other) |
| Indicates whether this MIME type is equal to another MIME type. More...
|
|
str | stripExtension (self, str file_name) |
| Strip the extension from a file name when it corresponds to one of the suffixes of this MIME type. More...
|
|
Simple value type class that encapsulates MIME type data.
◆ __init__()
None UM.MimeTypeDatabase.MimeType.__init__ |
( |
|
self, |
|
|
str |
name, |
|
|
str |
comment, |
|
|
Optional[List[str]] |
suffixes, |
|
|
str |
preferred_suffix = None |
|
) |
| |
Constructor.
- Parameters
-
name | The MIME type name, like "text/plain". |
comment | A description of the MIME type. |
suffixes | A list of possible suffixes for the type. |
preferred_suffix | The preferred suffix for the type. Defaults to suffixes[0] if not specified. |
◆ __eq__()
bool UM.MimeTypeDatabase.MimeType.__eq__ |
( |
|
self, |
|
|
object |
other |
|
) |
| |
Indicates whether this MIME type is equal to another MIME type.
They are equal if the names match, since MIME types should have unique names.
- Returns
True
if the two MIME types are equal, or False
otherwise.
◆ __repr__()
str UM.MimeTypeDatabase.MimeType.__repr__ |
( |
|
self | ) |
|
Gives a programmer-readable representation of the MIME type.
- Returns
- A string representing the MIME type.
◆ comment()
str UM.MimeTypeDatabase.MimeType.comment |
( |
|
self | ) |
|
The comment that describes of the MIME type.
◆ fromQMimeType()
"MimeType" UM.MimeTypeDatabase.MimeType.fromQMimeType |
( |
QMimeType |
qt_mime | ) |
|
|
static |
Create a MimeType
object from a QMimeType
object.
- Parameters
-
qt_mime | The QMimeType object to convert. |
- Returns
- A new
MimeType
object with properties equal to the QMimeType
object.
◆ name()
str UM.MimeTypeDatabase.MimeType.name |
( |
|
self | ) |
|
The name that identifies the MIME type.
◆ preferredSuffix()
str UM.MimeTypeDatabase.MimeType.preferredSuffix |
( |
|
self | ) |
|
The preferred file name suffix for the MIME type.
◆ stripExtension()
str UM.MimeTypeDatabase.MimeType.stripExtension |
( |
|
self, |
|
|
str |
file_name |
|
) |
| |
Strip the extension from a file name when it corresponds to one of the suffixes of this MIME type.
- Parameters
-
file_name | The file name to strip of extension. |
- Returns
file_name
without extension, or file_name
when it does not match.
◆ suffixes()
List[str] UM.MimeTypeDatabase.MimeType.suffixes |
( |
|
self | ) |
|
The list of file name suffixes for the MIME type.
The documentation for this class was generated from the following file: