itdominator/SolarFM
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added favorites plugin, addedplugin logic, updated confs

Browse Source
This commit is contained in:
itdominator
2022-09-03 00:43:25 -05:00
parent 09d8170953
commit 247f1a1165
12 changed files with 405 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/README.md
View File

@@ -6,7 +6,6 @@ Plugins must have a run method defined; though, you do not need to necessarily d
### Manifest Example (All are required even if empty.)
```
class Manifest:
path: str = os.path.dirname(os.path.realpath(__file__))
name: str = "Example Plugin"
author: str = "John Doe"
version: str = "0.0.1"
@@ -14,7 +13,6 @@ class Manifest:
requests: {} = {
'ui_target': "plugin_control_list",
'pass_fm_events': "true"
}
```
@@ -23,8 +21,9 @@ class Manifest:
```
requests: {} = {
'ui_target': "plugin_control_list",
'ui_target_id': "<some other Gtk Glade ID>" # Only needed if using "other" in "ui_target". See below for predefined "ui_target" options...
'pass_fm_events': "true" # If empty or not present will be ignored.
'ui_target_id': "<some other Gtk Glade ID>", # Only needed if using "other" in "ui_target". See below for predefined "ui_target" options...
'pass_fm_events': "true", # If empty or not present will be ignored.
"pass_ui_objects": [""], # Request reference to a UI component. Will be passed back as array to plugin.
'bind_keys': [f"{name}||send_message:<Control>f"],
f"{name}||do_save:<Control>s"] # Bind keys with method and key pare using list. Must pass "name" like shown with delimiter to its right.
@@ -58,4 +57,8 @@ def set_fm_event_system(self, fm_event_system):
def run(self):
self._module_event_observer()
# Must define in plugin if "pass_ui_objects" is set and an array of valid glade UI IDs.
def set_ui_object_collection(self, ui_objects):
self._ui_objects = ui_objects
```