IPluginModPage

class mobase.IPluginModPage

Bases: IPlugin

Methods Summary

`displayName`()	rtype: `str`
`handlesDownload`(page_url, download_url, fileinfo)	Check if the plugin handles the specified download.
`icon`()	rtype: `QIcon`
`pageURL`()	rtype: `QUrl`
`setParentWidget`(parent)	Set the parent widget for this mod page.
`useIntegratedBrowser`()	Indicates if the page should be displayed in the integrated browser.

Methods Documentation

abstract displayName()

Return type:: str
Returns:: The name of the page as displayed in the UI.

abstract handlesDownload(page_url, download_url, fileinfo)

Check if the plugin handles the specified download.

Return type:

bool

Parameters:

page_url – URL of the page that contains the download link.
download_url – The download URL.
fileinfo – Not usable in python.

Returns:

True if this plugin wants to handle the specified download, False otherwise.

abstract icon()

Return type:: QIcon
Returns:: The icon to display with the page.

abstract pageURL()

Return type:: QUrl
Returns:: The URL to open when the user wants to visit this mod page.

setParentWidget(parent)

Set the parent widget for this mod page.

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 useIntegratedBrowser()

Indicates if the page should be displayed in the integrated browser.

Unless the page provides a special means of starting downloads (like the nxm:// url schema on nexus), it will not be possible to handle downloads unless the integrated browser is used!

Return type:: bool
Returns:: True if the page should be opened in the integrated browser, False otherwise.