itom.filterHelp

itom.filterHelp([filterName, dictionary = 0, furtherInfos = 0]) → generates an online help for the given filter(s).

Generates an online help for the given widget or returns a list of available filter.

Parameters :

filterName : {str}, optional

is the fullname or a part of any filter-name which should be displayed. If filterName is none or no filter matches filterName casesensitiv a list with all suitable filters is given.

dictionary : {dict}, optional

if dictionary == 1, function returns an Py_Dictionary with parameters Default value is 0.

furtherInfos : {int}, optional

defines if a complete parameter-list of name-related filters to the given filterName should be displayed (1)

Returns :

Returns none or a PyDictionary depending on the value of dictionary. :