Различия

Показаны различия между двумя версиями страницы.

--- products:pyrog:api:lastest:types:helper [2026/05/15 20:49] – создано - внешнее изменение 127.0.0.1
+++ products:pyrog:api:lastest:types:helper [2026/08/08 22:24] (текущий) – удалено - внешнее изменение (Дата неизвестна) 127.0.0.1
@@ Строка 1: / Строка 1: @@
-~~NOTOC~~
-<WRAP center round info 80%>
-Текст документации сгенерирован автоматически из [[https://github.com/iron-mesh/Pyrog|исходного кода]].\\
-Если обнаружили ошибку, отправьте об этом сообщение на [[feedback@ironmesh.ru|📧почту]].
-</WRAP>
-====== Module: helper ======
-===== Classes =====
-==== HelperBridge ====
-=== Methods ===
-== register_helper_instance ==
-<code python>def register_helper_instance(calling_filepath: str, helper_instance) -> bool</code>
-**Parameters:**
-  * **calling_filepath**: //str// — (without description)
-  * **helper_instance**  — (without description)
-**Returns:**
-  * //bool// — (without description)
-== get_plugin_dir_for_file ==
-<code python>def get_plugin_dir_for_file(calling_filepath: str) -> str</code>
-**Parameters:**
-  * **calling_filepath**: //str// — (without description)
-**Returns:**
-  * //str// — (without description)
-== save_plugin_settings_values ==
-<code python>def save_plugin_settings_values(plugin_dir: str)</code>
-**Parameters:**
-  * **plugin_dir**: //str// — (without description)
-== save_plugin_settings_params ==
-<code python>def save_plugin_settings_params(plugin_dir: str)</code>
-**Parameters:**
-  * **plugin_dir**: //str// — (without description)
-== plugin_localstorage_dir_abspath ==
-<code python>def plugin_localstorage_dir_abspath(plugin_dir: str) -> str</code>
-**Parameters:**
-  * **plugin_dir**: //str// — (without description)
-**Returns:**
-  * //str// — (without description)
-==== Helper ====
-**Inherits:** QObject
-This class provides utilitarian functions and signals from Manager application.
-**Attributes:**
-  * **plugin_language_changing**: //Signal%%[%%str%%]%%// — This signal is sent when the user changes the current language of the plugin. The Manager application sends this signal when initializing the plugin if the selected language differs from the original one.
-  * **plugin_deactivating**: //Signal// — This signal is sent when the user deactivates the plugin; it is needed to notify the plugin that it is necessary to prepare for shutdown.
-  * **app_closing**: //Signal// — This signal is sent when the user closes the Manager application; it is needed to notify the plugin that it is necessary to prepare for shutdown.
-  * **settings_editing_starting**: //Signal// — This signal is sent when the user starts editing settings, before editing becomes available. It is necessary to notify the plugin that the values of settings can be changed at any time, and it should make the necessary preparations.
-  * **settings_editing_finished**: //Signal%%[%%bool%%]%%// — This signal is sent when the user has finished editing settings.
-    * //True// — the user has chosen save settings option
-    * //False// — the user has chosen cancellation of saving settings values.
-**Constructor:**
-<code python>def Helper.__init__(parent = None)</code>
-**Parameters:**
-  * **parent**  — (without description)
-=== Methods ===
-== delete ==
-<code python>def delete()</code>
-Delete instance of [[#helper|Helper]] class from list of instances.
-Attention: this method is only for Manager using.
-== save_settings_parameters ==
-<code python>def save_settings_parameters()</code>
-Saves settings parameters in database
-Saves parameters of properties of [[.:properties:property_container#propertycontainer|PropertyContainer]] that method [[.:plugin#plugin|Plugin]].settings() returns
-**Raises:**
-  * **RuntimeError** — the plugin has no settings.
-== save_settings_values ==
-<code python>def save_settings_values()</code>
-Saves settings values in database
-Saves values of properties of [[.:properties:property_container#propertycontainer|PropertyContainer]] that method [[.:plugin#plugin|Plugin]].settings() returns
-**Raises:**
-  * **RuntimeError** — the plugin has no settings.
-== plugin_dir_abspath ==
-<code python>def plugin_dir_abspath() -> str</code>
-Returns absolute plugin directory path
-**Returns:**
-  * //str// — absolute plugin directory path
-== plugin_localstorage_dir_abspath ==
-<code python>def plugin_localstorage_dir_abspath() -> str</code>
-Returns absolute path to plugin local storage directory located in "manager/data/plugins_ls"
-**Returns:**
-  * //str// — absolute path to plugin local storage directory