GeezerVison

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

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

wx.FileType¶

This class holds information about a given file type.

File type is the same as MIME type under Unix, but under Windows it corresponds more to an extension than to MIME type (in fact, several extensions may correspond to a file type).

This object may be created in several different ways: the program might know the file extension and wish to find out the corresponding MIME type or, conversely, it might want to find the right extension for the file to which it writes the contents of given MIME type. Depending on how it was created some fields may be unknown so the return value of all the accessors must be checked: False will be returned if the corresponding information couldn’t be found.

The objects of this class are never created by the application code but are returned by wx.MimeTypesManager.GetFileTypeFromMimeType and wx.MimeTypesManager.GetFileTypeFromExtension methods. But it is your responsibility to delete the returned pointer when you’re done with it!

A brief reminder about what the MIME types are (see the RFC 1341 for more information): basically, it is just a pair category/type (for example, “text/plain”) where the category is a basic indication of what a file is. Examples of categories are “application”, “image”, “text”, “binary”, and type is a precise definition of the document format: “plain” in the example above means just ASCII text without any formatting, while “text/html” is the HTML document source.

A MIME type may have one or more associated extensions: “text/plain” will typically correspond to the extension “.txt”, but may as well be associated with “.ini” or “.conf”.

MessageParameters class¶

One of the most common usages of MIME is to encode an e-mail message. The MIME type of the encoded message is an example of a message parameter. These parameters are found in the message headers (“Content-XXX”). At the very least, they must specify the MIME type and the version of MIME used, but almost always they provide additional information about the message such as the original file name or the charset (for the text documents). These parameters may be useful to the program used to open, edit, view or print the message, so, for example, an e-mail client program will have to pass them to this program. Because wx.FileType itself cannot know about these parameters, it uses wx.FileType.MessageParameters class to query them. The default implementation only requires the caller to provide the file name (always used by the program to be called - it must know which file to open) and the MIME type and supposes that there are no other parameters. If you wish to supply additional parameters, you must derive your own class from wx.FileType.MessageParameters and override GetParamValue() function, for example:

# provide the message parameters for the MIME type manager
class MailMessageParameters(wx.MessageParameters):

    def __init__(self, filename, mimetype):

        wx.MessageParameters.__init__(self, filename, mimetype)


    def GetParamValue(self, name):

        # parameter names are not case-sensitive
        if name.lower() == "charset":
            return "US-ASCII"
        else:
            return wx.MessageParameters.GetParamValue(name)

Now you only need to create an object of this class and pass it to, for example, GetOpenCommand like this:

if filetype.GetOpenCommand(MailMessageParameters("foo.txt", "text/plain")):

    # the full command for opening the text documents is in 'command'
    # (it might be "notepad foo.txt" under Windows or "cat foo.txt" under Unix)
    HandleCommand()

else:

    # we don't know how to handle such files...
    pass

Windows: As only the file name is used by the program associated with the given extension anyhow (but no other message parameters), there is no need to ever derive from wx.FileType.MessageParameters class for a Windows-only program.

Class Hierarchy¶

Inheritance diagram for class FileType:

Methods Summary¶

`__init__`	Copy constructor.
`ExpandCommand`	This function is primarily intended for GetOpenCommand and GetPrintCommand usage but may be also used by the application directly if, for example, you want to use some non-default command to open the file.
`GetAllCommands`	Returns a tuple containing the verbs and commands arrays, corresponding for the registered information for this mime type.
`GetDescription`	Returns a brief description for this file type: for example, “text document” for
`GetExpandedCommand`	The returned string is the command to be executed in order to open/print/edit the file of the given type.
`GetExtensions`	Returns all extensions associated with this file type: for
`GetIcon`	Return the icon associated with this mime type, if any.
`GetIconInfo`	Returns a tuple containing the Icon for this file type, the file where the
`GetIconLocation`	Returns a wx.IconLocation that can be used to fetch the icon for this mime type.
`GetMimeType`	Returns full MIME type specification for this file type: for example, “text/plain”.
`GetMimeTypes`	Same as GetMimeType but returns a list of types. This will usually contain
`GetOpenCommand`	Returns the command which must be executed (see wx.Execute()) in order
`GetPrintCommand`	Returns the command which must be executed (see Execute()) in order to

Properties Summary¶

`Description`	See `GetDescription`
`Extensions`	See `GetExtensions`
`Icon`	See `GetIcon`
`IconInfo`	See `GetIconInfo`
`IconLocation`	See `GetIconLocation`
`MimeType`	See `GetMimeType`
`MimeTypes`	See `GetMimeTypes`

Class API¶

class wx.FileType(object)¶

Possible constructors:

FileType(ftInfo) -> None

This class holds information about a given file type.

Methods¶

__init__(self, ftInfo)¶

Copy constructor.

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

static ExpandCommand(command, params)¶

This function is primarily intended for GetOpenCommand and GetPrintCommand usage but may be also used by the application directly if, for example, you want to use some non-default command to open the file.

The function replaces all occurrences of:

s with the full file name
t with the MIME type
%{param} with the value of the parameter param using the wx.FileType.MessageParameters object you pass to it.

If there is no ‘s’ in the command string (and the string is not empty), it is assumed that the command reads the data on stdin and so the effect is the same as “ %s” were appended to the string.

Unlike all other functions of this class, there is no error return for this function.

Parameters:

command (string)
params (wx.FileType.MessageParameters)

Return type:

str

GetAllCommands(self, params)¶

Returns a tuple containing the verbs and commands arrays, corresponding for the registered information for this mime type.

Parameters:: params (FileType.MessageParameters)
Return type:: Tuple[List[str], List[str]]

GetDescription(self)¶

Returns a brief description for this file type: for example, “text document” for the “text/plain” MIME type.

Return type:: str

GetExpandedCommand(self, verb, params)¶

The returned string is the command to be executed in order to open/print/edit the file of the given type.

If the string is empty, the lookup for the verb failed.

The name of the file is retrieved from the wx.FileType.MessageParameters class.

Parameters:

verb (string)
params (FileType.MessageParameters)

Return type:

str

Added in version 4.1/wxWidgets-3.1.1.

Properties¶

Description¶: See GetDescription

Extensions¶: See GetExtensions

Icon¶: See GetIcon

IconInfo¶: See GetIconInfo

IconLocation¶: See GetIconLocation

MimeType¶: See GetMimeType

MimeTypes¶: See GetMimeTypes

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.