IPluginModPage

class mobase.IPluginModPage

Bases: mobase.IPlugin

Methods Summary

displayName()	returns The name of the page as displayed in the UI.
handlesDownload(page_url, download_url, fileinfo)	Check if the plugin handles the specified download.
icon()	returns The icon to display with the page.
pageURL()	returns The URL to open when the user wants to visit this mod page.
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()

Returns

The name of the page as displayed in the UI.

Return type

str

abstract handlesDownload(page_url, download_url, fileinfo)

Check if the plugin handles the specified download.

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.

Return type

bool

abstract icon()

Returns

The icon to display with the page.

Return type

QIcon

abstract pageURL()

Returns

The URL to open when the user wants to visit this mod page.

Return type

QUrl

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.

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!

Returns

True if the page should be opened in the integrated browser, False otherwise.

Return type

bool