Package trac :: Package prefs :: Module api :: Class IPreferencePanelProvider

Class IPreferencePanelProvider

    object --+    
             |    
core.Interface --+
                 |
                IPreferencePanelProvider

Provides panels for managing user preferences.

Instance Methods

get_preference_panels(req)
Return a list of available preference panels.

source code

render_preference_panel(req, panel)
Process a request for a preference panel.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

get_preference_panels(req)

source code

Return a list of available preference panels.

The items returned by this function must be tuple of the form (panel, label), or (panel, label, parent_panel) for child panels.

render_preference_panel(req, panel)

source code

Process a request for a preference panel.

This function should return a tuple of the form (template, data), where template is the name of the template to use and data is the data to be passed to the template.