2020-09-24 13:47:11 +00:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
2021-01-18 21:09:43 +00:00
< meta charset = "utf-8" />
2020-09-24 13:47:11 +00:00
2021-01-18 21:09:43 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" />
2020-09-24 13:47:11 +00:00
< title > IPluginTool — MO2 Python Plugin API 2.3rc1 documentation</ title >
< link rel = "stylesheet" href = "../_static/css/theme.css" type = "text/css" />
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" />
< link rel = "stylesheet" href = "../_static/graphviz.css" type = "text/css" />
2020-09-24 14:17:15 +00:00
< link rel = "shortcut icon" href = "../_static/mo2.ico" />
2021-01-18 21:09:43 +00:00
2020-09-24 13:47:11 +00:00
2021-01-18 21:09:43 +00:00
2020-09-24 13:47:11 +00:00
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
< script type = "text/javascript" id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" ></ script >
< script src = "../_static/jquery.js" ></ script >
< script src = "../_static/underscore.js" ></ script >
< script src = "../_static/doctools.js" ></ script >
< script src = "../_static/language_data.js" ></ script >
< script type = "text/javascript" src = "../_static/js/theme.js" ></ script >
< link rel = "index" title = "Index" href = "../genindex.html" />
< link rel = "search" title = "Search" href = "../search.html" />
< link rel = "next" title = "IProfile" href = "mobase.IProfile.html" />
2021-01-18 21:09:43 +00:00
< link rel = "prev" title = "IPluginRequirement" href = "mobase.IPluginRequirement.html" />
2020-09-24 13:47:11 +00:00
</ head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2021-01-18 21:09:43 +00:00
< a href = "../index.html" class = "icon icon-home" > MO2 Python Plugin API
2020-09-24 13:47:11 +00:00
</ a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" />
< input type = "hidden" name = "check_keywords" value = "yes" />
< input type = "hidden" name = "area" value = "default" />
</ form >
</ div >
</ div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" >< span class = "caption-text" > Contents:</ span ></ p >
< ul class = "current" >
< li class = "toctree-l1" >< a class = "reference internal" href = "../setup-tools.html" > Setting up the environment</ a >< ul >
< li class = "toctree-l2" >< a class = "reference internal" href = "../setup-tools.html#required-tools" > Required tools</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../setup-tools.html#preparation" > Preparation</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "../setup-tools.html#get-the-mobase-stubs" > 1. Get the < code class = "docutils literal notranslate" >< span class = "pre" > mobase</ span ></ code > stubs</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../setup-tools.html#configure-visual-studio-code-for-mobase" > 2. Configure Visual Studio Code for < code class = "docutils literal notranslate" >< span class = "pre" > mobase</ span ></ code ></ a ></ li >
2021-02-26 18:26:36 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "../setup-tools.html#optional-configure-black-to-auto-format-your-source-files" > 3. [Optional] Configure < code class = "docutils literal notranslate" >< span class = "pre" > black</ span ></ code > to auto-format your source files</ a ></ li >
2021-01-18 21:09:43 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "../setup-tools.html#optional-automatically-reload-plugins-during-development" > 4. [Optional] Automatically reload plugins during development</ a ></ li >
2020-09-24 13:47:11 +00:00
</ ul >
</ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../setup-tools.html#testing-the-setup" > Testing the setup</ a ></ li >
</ ul >
</ li >
< li class = "toctree-l1" >< a class = "reference internal" href = "../plugin-types.html" > Type of Plugins</ a >< ul >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#installers" > Installers</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#previewers" > Previewers</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#mod-page" > Mod Page</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#game" > Game</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#tool" > Tool</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#proxies" > Proxies</ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#free-plugins" >< em > Free Plugins</ em ></ a ></ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../plugin-types.html#extension-interfaces" > Extension Interfaces</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "../plugin-types.html#diagnose" > Diagnose</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../plugin-types.html#file-mappings" > File Mappings</ a ></ li >
</ ul >
</ li >
</ ul >
</ li >
< li class = "toctree-l1" >< a class = "reference internal" href = "../writing-plugins.html" > Writing Plugins</ a >< ul >
< li class = "toctree-l2" >< a class = "reference internal" href = "../writing-plugins.html#getting-started" > Getting started</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#single-file-plugins" > Single file plugins</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#module-plugins" > Module Plugins</ a ></ li >
</ ul >
</ li >
< li class = "toctree-l2" >< a class = "reference internal" href = "../writing-plugins.html#writing-the-plugin" > Writing the plugin</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#iplugin-interface" >< code class = "docutils literal notranslate" >< span class = "pre" > IPlugin</ span ></ code > interface</ a ></ li >
</ ul >
</ li >
2020-10-07 18:49:09 +00:00
< li class = "toctree-l2" >< a class = "reference internal" href = "../writing-plugins.html#examples" > Examples</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#tutorial-plugins" > Tutorial Plugins</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#official-plugins" > Official Plugins</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#unofficial-plugins" > Unofficial Plugins</ a ></ li >
</ ul >
</ li >
2021-02-06 18:58:42 +00:00
< li class = "toctree-l2" >< a class = "reference internal" href = "../writing-plugins.html#internationalization" > Internationalization</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#adding-translation-code" > Adding translation code</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#generating-qt-translation-files" > Generating Qt translation files</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#translating" > Translating</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "../writing-plugins.html#distributing-translations" > Distributing translations</ a ></ li >
</ ul >
</ li >
2020-09-24 13:47:11 +00:00
</ ul >
</ li >
< li class = "toctree-l1" >< a class = "reference internal" href = "../faq.html" > FAQ</ a >< ul >
< li class = "toctree-l2" >< a class = "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 >
< li class = "toctree-l2" >< a class = "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 >
< li class = "toctree-l2" >< a class = "reference internal" href = "../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working" > 3. Why are my < code class = "docutils literal notranslate" >< span class = "pre" > isinstance(x,</ span > < span class = "pre" > QObject)</ span ></ code > and < code class = "docutils literal notranslate" >< span class = "pre" > isinstance(y,</ span > < span class = "pre" > QWidget)</ span ></ code > not working?</ a ></ li >
</ ul >
</ li >
< li class = "toctree-l1 current" >< a class = "reference internal" href = "../mobase.html" >< code class = "docutils literal notranslate" >< span class = "pre" > mobase</ span ></ code > API</ a >< ul class = "current" >
< li class = "toctree-l2" >< a class = "reference internal" href = "../mobase.html#functions" > Functions</ a >< ul >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.getFileVersion.html" > getFileVersion</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.getIconForExecutable.html" > getIconForExecutable</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.getProductVersion.html" > getProductVersion</ a ></ li >
</ ul >
</ li >
< li class = "toctree-l2 current" >< a class = "reference internal" href = "../mobase.html#classes" > Classes</ a >< ul class = "current" >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.BSAInvalidation.html" > BSAInvalidation</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.DataArchives.html" > DataArchives</ a ></ li >
2021-01-18 21:09:43 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.EndorsedState.html" > EndorsedState</ a ></ li >
2020-09-24 13:47:11 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ExecutableForcedLoadSetting.html" > ExecutableForcedLoadSetting</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ExecutableInfo.html" > ExecutableInfo</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.FileInfo.html" > FileInfo</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.FileTreeEntry.html" > FileTreeEntry</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.GamePlugins.html" > GamePlugins</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.GuessQuality.html" > GuessQuality</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.GuessedString.html" > GuessedString</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IDownloadManager.html" > IDownloadManager</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IFileTree.html" > IFileTree</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IInstallationManager.html" > IInstallationManager</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IModInterface.html" > IModInterface</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IModList.html" > IModList</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IModRepositoryBridge.html" > IModRepositoryBridge</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IOrganizer.html" > IOrganizer</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPlugin.html" > IPlugin</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginDiagnose.html" > IPluginDiagnose</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginFileMapper.html" > IPluginFileMapper</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginGame.html" > IPluginGame</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginInstaller.html" > IPluginInstaller</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginInstallerCustom.html" > IPluginInstallerCustom</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginInstallerSimple.html" > IPluginInstallerSimple</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginList.html" > IPluginList</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginModPage.html" > IPluginModPage</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginPreview.html" > IPluginPreview</ a ></ li >
2021-01-18 21:09:43 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginRequirement.html" > IPluginRequirement</ a ></ li >
2020-09-24 13:47:11 +00:00
< li class = "toctree-l3 current" >< a class = "current reference internal" href = "#" > IPluginTool</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IProfile.html" > IProfile</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ISaveGame.html" > ISaveGame</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ISaveGameInfoWidget.html" > ISaveGameInfoWidget</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.InstallResult.html" > InstallResult</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.InterfaceNotImplemented.html" > InterfaceNotImplemented</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.LoadOrderMechanism.html" > LoadOrderMechanism</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.LocalSavegames.html" > LocalSavegames</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.Mapping.html" > Mapping</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModDataChecker.html" > ModDataChecker</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModDataContent.html" > ModDataContent</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModRepositoryFileInfo.html" > ModRepositoryFileInfo</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModState.html" > ModState</ a ></ li >
2021-01-18 21:09:43 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.PluginRequirementFactory.html" > PluginRequirementFactory</ a ></ li >
2020-09-24 13:47:11 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.PluginSetting.html" > PluginSetting</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.PluginState.html" > PluginState</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ProfileSetting.html" > ProfileSetting</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ReleaseType.html" > ReleaseType</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.SaveGameInfo.html" > SaveGameInfo</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ScriptExtender.html" > ScriptExtender</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.SortMechanism.html" > SortMechanism</ a ></ li >
2021-01-18 21:09:43 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.TrackedState.html" > TrackedState</ a ></ li >
2020-09-24 13:47:11 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.UnmanagedMods.html" > UnmanagedMods</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.VersionInfo.html" > VersionInfo</ a ></ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.VersionScheme.html" > VersionScheme</ a ></ li >
</ ul >
</ li >
</ ul >
</ li >
</ ul >
</ div >
</ div >
</ nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" ></ i >
< a href = "../index.html" > MO2 Python Plugin API</ a >
</ nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2021-01-18 21:09:43 +00:00
2020-09-24 13:47:11 +00:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li >< a href = "../index.html" class = "icon icon-home" ></ a > » </ li >
< li >< a href = "../mobase.html" >< code class = "docutils literal notranslate" >< span class = "pre" > mobase</ span ></ code > API</ a > » </ li >
< li > IPluginTool</ li >
< li class = "wy-breadcrumbs-aside" >
2021-01-18 21:09:43 +00:00
2020-09-24 13:47:11 +00:00
< a href = "../_sources/api/mobase.IPluginTool.rst.txt" rel = "nofollow" > View page source</ a >
</ li >
</ ul >
< hr />
</ div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "iplugintool" >
< h1 > IPluginTool< a class = "headerlink" href = "#iplugintool" title = "Permalink to this headline" > ¶</ a ></ h1 >
< dl class = "class" >
< dt id = "mobase.IPluginTool" >
< em class = "property" > class </ em >< code class = "sig-prename descclassname" > mobase.</ code >< code class = "sig-name descname" > IPluginTool</ code >< a class = "headerlink" href = "#mobase.IPluginTool" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< p > Bases: < a class = "reference internal" href = "mobase.IPlugin.html#mobase.IPlugin" title = "mobase.IPlugin" >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > mobase.IPlugin</ span ></ code ></ a ></ p >
2021-01-18 21:09:43 +00:00
< p > This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools sub-menu
2020-09-24 13:47:11 +00:00
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’
application itself.</ p >
< p class = "rubric" > Methods Summary</ p >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" />
< col style = "width: 90%" />
</ colgroup >
< tbody >
< tr class = "row-odd" >< td >< p >< a class = "reference internal" href = "#mobase.IPluginTool.display" title = "mobase.IPluginTool.display" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > display</ span ></ code ></ a > ()</ p ></ td >
< td >< p > Called when the user starts the tool.</ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< a class = "reference internal" href = "#mobase.IPluginTool.displayName" title = "mobase.IPluginTool.displayName" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > displayName</ span ></ code ></ a > ()</ p ></ td >
< td >< p >< dl class = "field-list simple" >
< dt class = "field-odd" > returns</ dt >
< dd class = "field-odd" >< p > The display name for this tool, as shown in the tool menu.</ p >
</ dd >
</ dl >
</ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< a class = "reference internal" href = "#mobase.IPluginTool.icon" title = "mobase.IPluginTool.icon" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > icon</ span ></ code ></ a > ()</ p ></ td >
< td >< p >< dl class = "field-list simple" >
< dt class = "field-odd" > returns</ dt >
< dd class = "field-odd" >< p > The icon for this tool, or a default-constructed QICon().</ p >
</ dd >
</ dl >
</ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< a class = "reference internal" href = "#mobase.IPluginTool.setParentWidget" title = "mobase.IPluginTool.setParentWidget" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > setParentWidget</ span ></ code ></ a > (parent)</ p ></ td >
< td >< p > Set the parent widget for this tool.</ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< a class = "reference internal" href = "#mobase.IPluginTool.tooltip" title = "mobase.IPluginTool.tooltip" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > tooltip</ span ></ code ></ a > ()</ p ></ td >
< td >< p >< dl class = "field-list simple" >
< dt class = "field-odd" > returns</ dt >
< dd class = "field-odd" >< p > The tooltip for this tool.</ p >
</ dd >
</ dl >
</ p ></ td >
</ tr >
</ tbody >
</ table >
< p class = "rubric" > Methods Documentation</ p >
< dl class = "method" >
< dt id = "mobase.IPluginTool.display" >
< em class = "property" > abstract </ em >< code class = "sig-name descname" > display</ code >< span class = "sig-paren" > (</ span >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.IPluginTool.display" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< p > Called when the user starts the tool.</ p >
</ dd ></ dl >
< dl class = "method" >
< dt id = "mobase.IPluginTool.displayName" >
< em class = "property" > abstract </ em >< code class = "sig-name descname" > displayName</ code >< span class = "sig-paren" > (</ span >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.IPluginTool.displayName" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< dl class = "field-list simple" >
< dt class = "field-odd" > Returns</ dt >
< dd class = "field-odd" >< p > The display name for this tool, as shown in the tool menu.</ p >
</ dd >
< dt class = "field-even" > Return type</ dt >
< dd class = "field-even" >< p >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > str</ span ></ code ></ p >
</ dd >
</ dl >
</ dd ></ dl >
< dl class = "method" >
< dt id = "mobase.IPluginTool.icon" >
< em class = "property" > abstract </ em >< code class = "sig-name descname" > icon</ code >< span class = "sig-paren" > (</ span >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.IPluginTool.icon" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< dl class = "field-list simple" >
< dt class = "field-odd" > Returns</ dt >
< dd class = "field-odd" >< p > The icon for this tool, or a default-constructed QICon().</ p >
</ dd >
< dt class = "field-even" > Return type</ dt >
< dd class = "field-even" >< p >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > QIcon</ span ></ code ></ p >
</ dd >
</ dl >
</ dd ></ dl >
< dl class = "method" >
< dt id = "mobase.IPluginTool.setParentWidget" >
< code class = "sig-name descname" > setParentWidget</ code >< span class = "sig-paren" > (</ span >< em class = "sig-param" > parent</ em >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.IPluginTool.setParentWidget" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< p > Set the parent widget for this tool.</ 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters</ dt >
< dd class = "field-odd" >< p >< strong > parent</ strong > – </ p >
</ dd >
</ dl >
</ dd ></ dl >
< dl class = "method" >
< dt id = "mobase.IPluginTool.tooltip" >
< em class = "property" > abstract </ em >< code class = "sig-name descname" > tooltip</ code >< span class = "sig-paren" > (</ span >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.IPluginTool.tooltip" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< dl class = "field-list simple" >
< dt class = "field-odd" > Returns</ dt >
< dd class = "field-odd" >< p > The tooltip for this tool.</ p >
</ dd >
< dt class = "field-even" > Return type</ dt >
< dd class = "field-even" >< p >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > str</ span ></ code ></ p >
</ dd >
</ dl >
</ dd ></ dl >
</ dd ></ dl >
</ div >
</ div >
</ div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2021-01-18 21:09:43 +00:00
< a href = "mobase.IProfile.html" class = "btn btn-neutral float-right" title = "IProfile" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" ></ span ></ a >
< a href = "mobase.IPluginRequirement.html" class = "btn btn-neutral float-left" title = "IPluginRequirement" accesskey = "p" rel = "prev" >< span class = "fa fa-arrow-circle-left" aria-hidden = "true" ></ span > Previous</ a >
2020-09-24 13:47:11 +00:00
</ div >
< hr />
< div role = "contentinfo" >
< p >
2021-01-18 21:09:43 +00:00
© Copyright 2020, Holt59.
2020-09-24 13:47:11 +00:00
</ p >
</ div >
2021-01-18 21:09:43 +00:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx</ a > using a
2020-09-24 13:47:11 +00:00
2021-01-18 21:09:43 +00:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme</ a >
2020-09-24 13:47:11 +00:00
provided by < a href = "https://readthedocs.org" > Read the Docs</ a > .
</ footer >
</ div >
</ div >
</ section >
</ div >
< script type = "text/javascript" >
jQuery ( function () {
SphinxRtdTheme . Navigation . enable ( true );
});
</ script >
</ body >
</ html >
