-
-
Notifications
You must be signed in to change notification settings - Fork 35
UBA Context Plugins
There are two different plugins in UBA, UBA plugins and UBA context plugins.
Read about UBA plugins at https://github.com/eliranwong/UniqueBible/wiki/UBA-Plugins
Below is description on UBA context plugins.
UBA context plugins are plugins used with right-click context menu.
A valid plugin file should be a python script with file extension ".py".
All UBA context plugins are placed in folder "plugins_context" inside UniqueBible home directory.
You need to enable this feature by checking "enablePlugins" on "Set Config Flags" window.
The text selected by user before a right-click is assigned to config.pluginContext, with which plugin could process selected text.
A context plugin could be as simple as below, to display selected text in a dialog window.
import config
config.mainWindow.displayMessage(config.pluginContext)
You may have multiple files for a plugin and some of which are shared library files, which you do not want to display on context menu.
You can do this by placing them into a sub-folder. Python files placed inside a sub-folder within the directory "plugins" are not displayed on menu.
An example for reference: https://github.com/eliranwong/UniqueBible/wiki/UBA-Plugins#an-example---multiple-files