GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing docs.wxpython.org — wx.MimeTypesManager — wxPython 4.3.2 Docs

wx.MimeTypesManager¶

This class allows the application to retrieve information about all known MIME types from a system-specific location and the filename extensions to the MIME types and vice versa.

MIME stands for “Multipurpose Internet Mail Extensions” and was originally used in mail protocols. It’s standardized by several RFCs.

Under Windows, the MIME type information is queried from registry. Under Linux and Unix, it is queried from the XDG data directories.

Currently, wx.MimeTypesManager is limited to reading MIME type information.

The application should not construct its own manager: it should use the object pointer wx.TheMimeTypesManager . The functions GetFileTypeFromMimeType and GetFileTypeFromExtension return a wx.FileType object which may be further queried for file description, icon and other attributes.

Helper functions¶

All of these functions are static (i.e. don’t need a wx.MimeTypesManager object to call them) and provide some useful operations for string representations of MIME types. Their usage is recommended instead of directly working with MIME types using String functions.

wx.MimeTypesManager.IsOfType

Query database¶

These functions are the heart of this class: they allow to find a file type object from either file extension or MIME type. If the function is successful, it returns a pointer to the wx.FileType object which must be deleted by the caller, otherwise nullptr will be returned.

wx.MimeTypesManager.GetFileTypeFromMimeType
wx.MimeTypesManager.GetFileTypeFromExtension

Class Hierarchy¶

Inheritance diagram for class MimeTypesManager:

Methods Summary¶

`__init__`	Constructor puts the object in the “working” state.
`AddFallbacks`	This function may be used to provide hard-wired fallbacks for the MIME types and extensions that might not be present in the system MIME database.
`Associate`	Create a new association using the fields of wx.FileTypeInfo (at least the MIME type and the extension should be set).
`EnumAllFileTypes`	Returns a list of all known file types.
`GetFileTypeFromExtension`	Gather information about the files with given extension and return the corresponding wx.FileType object or nullptr if the extension is unknown.
`GetFileTypeFromMimeType`	Gather information about the files with given MIME type and return the corresponding wx.FileType object or nullptr if the MIME type is unknown.
`IsOfType`	This function returns `True` if either the given mimeType is exactly the same as wildcard or if it has the same category and the subtype of wildcard is “”.
`Unassociate`	Undo `Associate` .

Class API¶

class wx.MimeTypesManager(object)¶

Possible constructors:

MimeTypesManager() -> None

This class allows the application to retrieve information about all known MIME types from a system-specific location and the filename extensions to the MIME types and vice versa.

Methods¶

__init__(self)¶

Constructor puts the object in the “working” state.

Return type:: None

AddFallbacks(self, fallbacks)¶

This function may be used to provide hard-wired fallbacks for the MIME types and extensions that might not be present in the system MIME database.

Please see the typetest sample for an example of using it.

Parameters:: fallbacks (wx.FileTypeInfo)
Return type:: None

Associate(self, ftInfo)¶

Create a new association using the fields of wx.FileTypeInfo (at least the MIME type and the extension should be set).

Parameters:: ftInfo (wx.FileTypeInfo)
Return type:: wx.FileType

EnumAllFileTypes(self)¶

Returns a list of all known file types.

Return type:: List[str]

GetFileTypeFromExtension(self, extension)¶

Gather information about the files with given extension and return the corresponding wx.FileType object or nullptr if the extension is unknown.

The extension parameter may have, or not, the leading dot, if it has it, it is stripped automatically. It must not however be empty.

Parameters:: extension (string)
Return type:: wx.FileType

GetFileTypeFromMimeType(self, mimeType)¶

Gather information about the files with given MIME type and return the corresponding wx.FileType object or nullptr if the MIME type is unknown.

Parameters:: mimeType (string)
Return type:: wx.FileType

static IsOfType(mimeType, wildcard)¶

This function returns True if either the given mimeType is exactly the same as wildcard or if it has the same category and the subtype of wildcard is “”.

Note that the “x” wildcard is not allowed in mimeType itself.

The comparison done by this function is case insensitive so it is not necessary to convert the strings to the same case before calling it.

Parameters:

mimeType (string)
wildcard (string)

Return type:

bool

Unassociate(self, ft)¶

Undo Associate .

Parameters:: ft (wx.FileType)
Return type:: bool

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.