IPluginTool

class mobase.IPluginTool

Bases: IPlugin

This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools sub-menu and get invoked when the user clicks it. They are expected to have a user interface of some sort. These are almost like independent applications except they can access all Mod Organizer interfaces like querying and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin can (and should!) integrate its UI as a window inside MO and thus doesn’t have to initialize a windows application itself.

Methods Summary

`display`()	Called when the user starts the tool.
`displayName`()	rtype: `str`
`icon`()	rtype: `QIcon`
`setParentWidget`(parent)	Set the parent widget for this tool.
`tooltip`()	rtype: `str`

Methods Documentation

abstract display()

Called when the user starts the tool.

Return type:: None

abstract displayName()

Return type:: str
Returns:: The display name for this tool, as shown in the tool menu.

abstract icon()

Return type:: QIcon
Returns:: The icon for this tool, or a default-constructed QICon().

setParentWidget(parent)

Set the parent widget for this tool.

Python plugins usually do not need to re-implement this and can directly access the parent widget using _parentWidget() once the UI has been initialized.

Return type:: None
Parameters:: parent – The parent widget.

abstract tooltip()

Return type:: str
Returns:: The tooltip for this tool.