Peas.ExtensionBase¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r |
The full path of the directory where the plugin should look for its data files |
||
r/w/co |
Information related to the current plugin |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent_instance |
r |
Class Details¶
- class Peas.ExtensionBase(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
Base class for C extensions.
Peas.ExtensionBase
can optionally be used as a base class for the extensions of your plugin. By inheriting from it, you will make your extension able to access the related [class`PluginInfo`], and especially the location where all the data of your plugin lives.Non-C extensions will usually not inherit from this class: Python plugins automatically get a “plugin_info” attribute that serves the same purpose.
- get_data_dir()¶
- Returns:
A newly allocated string with the path of the directory where the plugin should look for its data files
- Return type:
Get the path of the directory where the plugin should look for its data files.
- get_plugin_info()¶
- Returns:
the [class`PluginInfo`] relative to the
Peas.ExtensionBase
.- Return type:
Get information relative to self.
Property Details¶
- Peas.ExtensionBase.props.data_dir¶
-
The The full path of the directory where the plugin should look for its data files.
Note: This is the same path as that returned by [method`PluginInfo`.get_data_dir].
- Peas.ExtensionBase.props.plugin_info¶
- Name:
plugin-info
- Type:
- Default Value:
- Flags:
The [class`PluginInfo`] related to the current plugin.