Это старая версия документа!
UBHelper
Класс, который включает в себя вспомогательные функции.
Методы
__init__()
Инициализация экземпляра, сюда следует передать ссылку на экземпляр UBWidget вашего плагина.
def __init__(self, key_class:UBWidget) -> None
Параметры:
- key_class(UBWidget) - ссылку на экземпляр UBWidget вашего плагина (нужен для идентификации контекста)
Возвращает:
- None
save_settings_parameters()
Сохраняет параметры свойств, которые находятся в классе PropertyContainer, который указан в поле ub_settings у класса плагина UBWidget и сохраняет их в базе данных. Это нужно сделать, когда программа изменяет параметры свойств, так как Менеджер при каждом запуске загружает параметры из базы данных, если этого не сделать, то будут загружены параметры по умолчанию или те, которые были сохранены ранее.
def save_settings_parameters(self) -> None
Возвращает:
- None
open_localstorage()
Возвращает объект базы данных Shelve, которая позволяет обращаться к данным через ключ, подобно встроенным словарям. По сути является оберткой для функции shelve.open(). Файлы базы данных сохраняются в корневой папке плагина во вложенной папке localdata.
def open_localstorage(self, flag='c', protocol=None, writeback=False)
Параметры:
Описание смотрите в официальной документации shelve.open()
Возвращает:
- Shelve-объект базы данных
__init__()
Менеджер вызывает этот метод, когда пользователь закрывает окно редактирования пользовательских настроек, выполнение производится когда данные в привязанном классе PropertyContainer обновлены. Определите здесь алгоритм, который нужно выполнить после того как пользователь закончил редактирование настроек.
def settings_edit_finished(self, changed:bool) -> None
Параметры:
- changed(bool) - данный параметр принимает значение Truе, если значение хотя бы одного свойства было изменено, иначе - False
Возвращает:
- None