<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#get-the-mobase-stubs">1. Get the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-visual-studio-code-for-mobase">2. Configure Visual Studio Code for <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code></a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-mypy-to-find-the-mobase-stubs">3. Configure <codeclass="docutils literal notranslate"><spanclass="pre">mypy</span></code> to find the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
</ul>
</li>
<liclass="toctree-l2"><aclass="reference internal"href="../setup-tools.html#testing-the-setup">Testing the setup</a></li>
</ul>
</li>
<liclass="toctree-l1"><aclass="reference internal"href="../plugin-types.html">Type of Plugins</a><ul>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-is-mo2-throwing-an-exception-when-i-try-to-create-a-type-inheriting-one-of-mo2-class">1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#how-can-i-be-sure-to-implement-all-the-required-methods-when-creating-a-plugin">2. How can I be sure to implement all the required methods when creating a plugin?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working">3. Why are my <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(x,</span><spanclass="pre">QObject)</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(y,</span><spanclass="pre">QWidget)</span></code> not working?</a></li>
<h1>IPluginModPage<aclass="headerlink"href="#ipluginmodpage"title="Permalink to this headline">¶</a></h1>
<dlclass="class">
<dtid="mobase.IPluginModPage">
<emclass="property">class </em><codeclass="sig-prename descclassname">mobase.</code><codeclass="sig-name descname">IPluginModPage</code><aclass="headerlink"href="#mobase.IPluginModPage"title="Permalink to this definition">¶</a></dt>
<td><p>Indicates if the page should be displayed in the integrated browser.</p></td>
</tr>
</tbody>
</table>
<pclass="rubric">Methods Documentation</p>
<dlclass="method">
<dtid="mobase.IPluginModPage.displayName">
<emclass="property">abstract </em><codeclass="sig-name descname">displayName</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IPluginModPage.displayName"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The name of the page as displayed in the UI.</p>
<emclass="property">abstract </em><codeclass="sig-name descname">handlesDownload</code><spanclass="sig-paren">(</span><emclass="sig-param">page_url</em>, <emclass="sig-param">download_url</em>, <emclass="sig-param">fileinfo</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IPluginModPage.handlesDownload"title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the plugin handles the specified download.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>page_url</strong>– URL of the page that contains the download link.</p></li>
<li><p><strong>download_url</strong>– The download URL.</p></li>
<li><p><strong>fileinfo</strong>– Not usable in python.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if this plugin wants to handle the specified download, False otherwise.</p>
<emclass="property">abstract </em><codeclass="sig-name descname">icon</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IPluginModPage.icon"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The icon to display with the page.</p>
<emclass="property">abstract </em><codeclass="sig-name descname">pageURL</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IPluginModPage.pageURL"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The URL to open when the user wants to visit this mod page.</p>
<codeclass="sig-name descname">setParentWidget</code><spanclass="sig-paren">(</span><emclass="sig-param">parent</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IPluginModPage.setParentWidget"title="Permalink to this definition">¶</a></dt>
<dd><p>Set the parent widget for this mod page.</p>
<p>Python plugins usually do not need to re-implement this and can directly access the parent
widget using <cite>_parentWidget()</cite> once the UI has been initialized.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>parent</strong>– The parent widget.</p>
<emclass="property">abstract </em><codeclass="sig-name descname">useIntegratedBrowser</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IPluginModPage.useIntegratedBrowser"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates if the page should be displayed in the integrated browser.</p>
<p>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!</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>True if the page should be opened in the integrated browser, False otherwise.</p>
