EJIO.ctk_extender.widget.form package

Subpackages

• EJIO.ctk_extender.widget.form.fields package
  • Submodules
  • EJIO.ctk_extender.widget.form.fields.base module
    • InputField
      • InputField.clear()
      • InputField.get_value()
      • InputField.name
      • InputField.set_value()
      • InputField.validate()
  • EJIO.ctk_extender.widget.form.fields.checkbox module
    • FormCheckBox
      • FormCheckBox.build()
      • FormCheckBox.clear()
      • FormCheckBox.get_value()
      • FormCheckBox.name
      • FormCheckBox.set_value()
  • EJIO.ctk_extender.widget.form.fields.combobox module
    • FormComboBox
      • FormComboBox.build()
      • FormComboBox.clear()
      • FormComboBox.get_value()
      • FormComboBox.name
      • FormComboBox.set_value()
  • EJIO.ctk_extender.widget.form.fields.directory module
    • FormDirectoryField
      • FormDirectoryField.build()
      • FormDirectoryField.clear()
      • FormDirectoryField.get_value()
      • FormDirectoryField.name
      • FormDirectoryField.set_value()
      • FormDirectoryField.validate()
  • EJIO.ctk_extender.widget.form.fields.file module
    • FormFileField
      • FormFileField.build()
      • FormFileField.clear()
      • FormFileField.get_value()
      • FormFileField.name
      • FormFileField.set_value()
      • FormFileField.validate()
  • EJIO.ctk_extender.widget.form.fields.option_menu module
    • FormOptionMenuField
      • FormOptionMenuField.build()
      • FormOptionMenuField.clear()
      • FormOptionMenuField.destroy()
      • FormOptionMenuField.get_value()
      • FormOptionMenuField.name
      • FormOptionMenuField.set_value()
      • FormOptionMenuField.validate()
  • EJIO.ctk_extender.widget.form.fields.radio module
    • FormRadioButtonGroup
      • FormRadioButtonGroup.build()
      • FormRadioButtonGroup.clear()
      • FormRadioButtonGroup.destroy()
      • FormRadioButtonGroup.get_value()
      • FormRadioButtonGroup.name
      • FormRadioButtonGroup.set_value()
  • EJIO.ctk_extender.widget.form.fields.segmented module
    • FormSegmentedButton
      • FormSegmentedButton.build()
      • FormSegmentedButton.clear()
      • FormSegmentedButton.get_value()
      • FormSegmentedButton.name
      • FormSegmentedButton.set_value()
  • EJIO.ctk_extender.widget.form.fields.slider module
    • FormSlider
      • FormSlider.build()
      • FormSlider.clear()
      • FormSlider.get_value()
      • FormSlider.name
      • FormSlider.set_value()
  • EJIO.ctk_extender.widget.form.fields.switch module
    • FormSwitch
      • FormSwitch.build()
      • FormSwitch.clear()
      • FormSwitch.get_value()
      • FormSwitch.name
      • FormSwitch.set_value()
  • EJIO.ctk_extender.widget.form.fields.text module
    • FormTextField
      • FormTextField.build()
      • FormTextField.clear()
      • FormTextField.get_value()
      • FormTextField.name
      • FormTextField.set_value()
      • FormTextField.validate()
  • EJIO.ctk_extender.widget.form.fields.textbox module
    • FormTextBox
      • FormTextBox.build()
      • FormTextBox.clear()
      • FormTextBox.get_value()
      • FormTextBox.name
      • FormTextBox.set_value()
      • FormTextBox.validate()
  • Module contents
    • FormCheckBox
      • FormCheckBox.build()
      • FormCheckBox.clear()
      • FormCheckBox.get_value()
      • FormCheckBox.name
      • FormCheckBox.set_value()
    • FormComboBox
      • FormComboBox.build()
      • FormComboBox.clear()
      • FormComboBox.get_value()
      • FormComboBox.name
      • FormComboBox.set_value()
    • FormDirectoryField
      • FormDirectoryField.build()
      • FormDirectoryField.clear()
      • FormDirectoryField.get_value()
      • FormDirectoryField.name
      • FormDirectoryField.set_value()
      • FormDirectoryField.validate()
    • FormFileField
      • FormFileField.build()
      • FormFileField.clear()
      • FormFileField.get_value()
      • FormFileField.name
      • FormFileField.set_value()
      • FormFileField.validate()
    • FormOptionMenuField
      • FormOptionMenuField.build()
      • FormOptionMenuField.clear()
      • FormOptionMenuField.destroy()
      • FormOptionMenuField.get_value()
      • FormOptionMenuField.name
      • FormOptionMenuField.set_value()
      • FormOptionMenuField.validate()
    • FormRadioButtonGroup
      • FormRadioButtonGroup.build()
      • FormRadioButtonGroup.clear()
      • FormRadioButtonGroup.destroy()
      • FormRadioButtonGroup.get_value()
      • FormRadioButtonGroup.name
      • FormRadioButtonGroup.set_value()
    • FormSegmentedButton
      • FormSegmentedButton.build()
      • FormSegmentedButton.clear()
      • FormSegmentedButton.get_value()
      • FormSegmentedButton.name
      • FormSegmentedButton.set_value()
    • FormSlider
      • FormSlider.build()
      • FormSlider.clear()
      • FormSlider.get_value()
      • FormSlider.name
      • FormSlider.set_value()
    • FormSwitch
      • FormSwitch.build()
      • FormSwitch.clear()
      • FormSwitch.get_value()
      • FormSwitch.name
      • FormSwitch.set_value()
    • FormTextBox
      • FormTextBox.build()
      • FormTextBox.clear()
      • FormTextBox.get_value()
      • FormTextBox.name
      • FormTextBox.set_value()
      • FormTextBox.validate()
    • FormTextField
      • FormTextField.build()
      • FormTextField.clear()
      • FormTextField.get_value()
      • FormTextField.name
      • FormTextField.set_value()
      • FormTextField.validate()
    • InputField
      • InputField.clear()
      • InputField.get_value()
      • InputField.name
      • InputField.set_value()
      • InputField.validate()

Submodules

EJIO.ctk_extender.widget.form.base module

class EJIO.ctk_extender.widget.form.base.Form(parent: <MagicMock name = 'mock.CTk.__or__().__or__()' id='140416957553632'>, geometry: Any = None)

Базовые классы: WidgetContainer

Специализированный контейнер для группировки элементов ввода. Автоматически собирает данные, проводит сквозную валидацию и очистку полей.

add_widget(widget_cls: type[W], *args: Any, **kwargs: Any) → W

Переопределенный метод добавления виджета. Если добавляемый виджет является полем ввода, регистрирует его в форме.

Параметры:

• widget_cls – Класс создаваемого виджета (наследник Widget).

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

• kwargs – Именованные аргументы для конструктора виджета.

Результат:

Созданный экземпляр виджета.

clear() → Self

Сбрасывает значения всех полей формы.

destroy() → None

Очищает реестр полей ввода и каскадно уничтожает контейнер.

focus_field(name: str) → None

Переводит фокус ввода на указанное поле формы по его имени. Безопасно извлекает внутренний инпут и запрашивает фокус у ОС.

Параметры:

name – Имя поля на которое нужно переключиться.

get_data() → dict[str, Any]

Собирает текущие данные со всех зарегистрированных полей ввода.

Результат:

Словарь, содержащий данные всех полей ввода в формате имя поля -> значение.

remove_widget(widget: W) → Self

Удаляет виджет из формы, синхронно вычищая его из реестра полей ввода и каскадно уничтожая его ресурсы.

Параметры:

widget – Экземпляр уничтожаемого виджета.

set_data(data: dict[str, Any]) → Self

Заполняет поля формы переданным словарем данных.

submit() → bool

Запускает процесс валидации и отправки формы. Генерирует FormSubmittedEvent при успехе или FormValidationErrorEvent при ошибке.

Результат:

True, если валидация успешна, иначе False.

EJIO.ctk_extender.widget.form.events module

class EJIO.ctk_extender.widget.form.events.FormReadyEvent(target_form: Any)

Базовые классы: Event

Событие-ответ, сообщающее форме, что её обработка завершена и она может принимать новые клики.

property target_form: Any

class EJIO.ctk_extender.widget.form.events.FormSubmittedEvent(sender: Any, data: dict[str, Any])

Базовые классы: Event

Событие, возникающее при успешной валидации и отправке формы.

property data: dict[str, Any]

class EJIO.ctk_extender.widget.form.events.FormValidationErrorEvent(sender: Any, errors: dict[str, str])

Базовые классы: Event

Событие, возникающее, если форма не прошла валидацию.

property errors: dict[str, str]

Module contents

class EJIO.ctk_extender.widget.form.Form(parent: <MagicMock name = 'mock.CTk.__or__().__or__()' id='140416957553632'>, geometry: Any = None)

Базовые классы: WidgetContainer

Специализированный контейнер для группировки элементов ввода. Автоматически собирает данные, проводит сквозную валидацию и очистку полей.

add_widget(widget_cls: type[W], *args: Any, **kwargs: Any) → W

Переопределенный метод добавления виджета. Если добавляемый виджет является полем ввода, регистрирует его в форме.

Параметры:

• widget_cls – Класс создаваемого виджета (наследник Widget).

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

• kwargs – Именованные аргументы для конструктора виджета.

Результат:

Созданный экземпляр виджета.

clear() → Self

Сбрасывает значения всех полей формы.

destroy() → None

Очищает реестр полей ввода и каскадно уничтожает контейнер.

focus_field(name: str) → None

Переводит фокус ввода на указанное поле формы по его имени. Безопасно извлекает внутренний инпут и запрашивает фокус у ОС.

Параметры:

name – Имя поля на которое нужно переключиться.

get_data() → dict[str, Any]

Собирает текущие данные со всех зарегистрированных полей ввода.

Результат:

Словарь, содержащий данные всех полей ввода в формате имя поля -> значение.

remove_widget(widget: W) → Self

Удаляет виджет из формы, синхронно вычищая его из реестра полей ввода и каскадно уничтожая его ресурсы.

Параметры:

widget – Экземпляр уничтожаемого виджета.

set_data(data: dict[str, Any]) → Self

Заполняет поля формы переданным словарем данных.

submit() → bool

Запускает процесс валидации и отправки формы. Генерирует FormSubmittedEvent при успехе или FormValidationErrorEvent при ошибке.

Результат:

True, если валидация успешна, иначе False.

class EJIO.ctk_extender.widget.form.FormCheckBox(parent: Any, name: str, text: str = '', geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Флажок (чекбокс) для формы (на базе ctk.CTkCheckBox).

build() → <MagicMock name='mock.CTkCheckBox' id='140416955675040'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → bool

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

class EJIO.ctk_extender.widget.form.FormComboBox(parent: Any, name: str, values: list[str], geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Выпадающий список (комбобокс) для формы (на базе ctk.CTkComboBox).

build() → <MagicMock name='mock.CTkComboBox' id='140416955713872'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → str

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

class EJIO.ctk_extender.widget.form.FormDirectoryField(parent: Any, name: str, label_text: str, required: bool = False, geometry: Any = None, **kwargs: Any)

Базовые классы: WidgetContainer, InputField

Поле формы для выбора директорий с поддержкой валидации и ограничений.

build() → <MagicMock name='mock.CTkFrame' id='140416972239120'>

Строит базовый контейнерный фрейм. Может быть переопределен в дочерних классах (например, для настройки бордеров или цвета).

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → str | list[str]

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

validate() → str | None

Проводит внутреннюю валидацию поля. :return: Строка с ошибкой, если она есть, иначе None.

class EJIO.ctk_extender.widget.form.FormFileField(parent: Any, name: str, label_text: str, file_types: list[tuple[str, str]] | None = None, multiple: bool = False, required: bool = False, geometry: Any = None, **kwargs: Any)

Базовые классы: WidgetContainer, InputField

Поле формы для выбора файлов с поддержкой валидации и ограничений.

build() → <MagicMock name='mock.CTkFrame' id='140416972239120'>

Строит базовый контейнерный фрейм. Может быть переопределен в дочерних классах (например, для настройки бордеров или цвета).

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → str | list[str]

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

validate() → str | None

Проводит внутреннюю валидацию поля. :return: Строка с ошибкой, если она есть, иначе None.

class EJIO.ctk_extender.widget.form.FormOptionMenuField(parent: Any, name: str, label_text: str, values: list[str], default_value: str | None = None, layout: Literal['row', 'column'] = 'row', required: bool = False, geometry: GeometryStrategy | None = None, **kwargs: Any)

Базовые классы: WidgetContainer, InputField

Высокоуровневое поле формы на базе выпадающего списка ctk.CTkOptionMenu. Интегрировано в подсистему валидации форм.

build() → <MagicMock name='mock.CTkFrame' id='140416972239120'>

Строит каркас поля формы с поддержкой сеточного позиционирования.

clear() → None

Сброс значения поля в дефолтное состояние.

destroy() → None

Каскадно уничтожает сам контейнер и все вложенные в него дочерние виджеты, полностью очищая оперативную память.

get_value() → str

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

validate() → str | None

Проверяет, выбрано ли значение, если поле обязательно.

class EJIO.ctk_extender.widget.form.FormRadioButtonGroup(parent: Any, name: str, options: list[str], geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Группа радио-кнопок для выбора одного значения из нескольких опций.

build() → <MagicMock name='mock.CTkFrame' id='140416972239120'>

Собирает невидимый фрейм-контейнер, внутри которого автоматически упаковывает радио-кнопки по вертикали.

clear() → None

Сброс значения поля в дефолтное состояние.

destroy() → None

Полностью уничтожает виджет, очищая память и удаляя его глобальные подписки.

get_value() → str

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

class EJIO.ctk_extender.widget.form.FormReadyEvent(target_form: Any)

Базовые классы: Event

Событие-ответ, сообщающее форме, что её обработка завершена и она может принимать новые клики.

property target_form: Any

class EJIO.ctk_extender.widget.form.FormSegmentedButton(parent: Any, name: str, values: list[str], geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Сегментированная кнопка выбора для формы (на базе ctk.CTkSegmentedButton).

build() → <MagicMock name='mock.CTkSegmentedButton' id='140416955763120'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → str

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

class EJIO.ctk_extender.widget.form.FormSlider(parent: Any, name: str, from_value: float = 0.0, to_value: float = 100.0, default_value: float = 0.0, geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Компонент ползунка для формы (на базе ctk.CTkSlider).

build() → <MagicMock name='mock.CTkSlider' id='140416955719344'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → float

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

class EJIO.ctk_extender.widget.form.FormSubmittedEvent(sender: Any, data: dict[str, Any])

Базовые классы: Event

Событие, возникающее при успешной валидации и отправке формы.

property data: dict[str, Any]

class EJIO.ctk_extender.widget.form.FormSwitch(parent: Any, name: str, text: str = '', geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Компонент тумблера/переключателя для формы (на базе ctk.CTkSwitch).

build() → <MagicMock name='mock.CTkSwitch' id='140416955725632'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → bool

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

class EJIO.ctk_extender.widget.form.FormTextBox(parent: Any, name: str, required: bool = False, geometry: GeometryStrategy | None = None)

Базовые классы: Widget, InputField

Многострочное текстовое поле ввода для формы (на базе ctk.CTkTextbox).

build() → <MagicMock name='mock.CTkTextbox' id='140416955767824'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → str

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

validate() → str | None

Проводит внутреннюю валидацию поля. :return: Строка с ошибкой, если она есть, иначе None.

class EJIO.ctk_extender.widget.form.FormTextField(parent: Any, name: str, placeholder: str = '', required: bool = False, geometry: GeometryStrategy | None = None, **kwargs: Any)

Базовые классы: Widget, InputField

Текстовое поле ввода для формы (на базе ctk.CTkEntry).

build() → <MagicMock name='mock.CTkEntry' id='140416955669664'>

Абстрактный метод сборки компонента. Должен быть переопределен в наследниках. Внутри него создаются и конфигурируются реальные ctk-объекты.

Результат:

Экземпляр реального ctk-виджета (например, ctk.CTkButton).

Исключение:

NotImplementedError – Должен быть определен в подклассе.

clear() → None

Сброс значения поля в дефолтное состояние.

get_value() → str

Возвращает текущее значение, введенное пользователем.

property name: str

Уникальное имя поля для формирования итогового словаря данных.

set_value(value: Any) → None

Программная установка значения в поле.

validate() → str | None

Проводит внутреннюю валидацию поля. :return: Строка с ошибкой, если она есть, иначе None.

class EJIO.ctk_extender.widget.form.FormValidationErrorEvent(sender: Any, errors: dict[str, str])

Базовые классы: Event

Событие, возникающее, если форма не прошла валидацию.

property errors: dict[str, str]

class EJIO.ctk_extender.widget.form.InputField(*args, **kwargs)

Базовые классы: Protocol

Протокол, описывающий требования к элементам ввода внутри Form. Разрешен для рантайм-проверок через isinstance().

abstractmethod clear() → None

Сброс значения поля в дефолтное состояние.

abstractmethod get_value() → Any

Возвращает текущее значение, введенное пользователем.

abstract property name: str

Уникальное имя поля для формирования итогового словаря данных.

abstractmethod set_value(value: Any) → None

Программная установка значения в поле.

validate() → str | None

Проводит внутреннюю валидацию поля. :return: Строка с ошибкой, если она есть, иначе None.