跳转至

pyguiadapter.widgets.common

CommonParameterWidgetConfig dataclass

Bases: BaseParameterWidgetConfig

通用参数控件配置类。继承自 BaseParameterWidgetConfig 类。是所有通用参数控件的配置基类。

Source code in pyguiadapter\widgets\common.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
@dataclasses.dataclass(frozen=True)
class CommonParameterWidgetConfig(BaseParameterWidgetConfig):
    """
    通用参数控件配置类。继承自 `BaseParameterWidgetConfig` 类。是所有通用参数控件的配置基类。
    """

    set_default_value_on_init: bool = True
    """
    是否在控件初始化时设置默认值。默认为 `True`。
    """

    hide_default_value_checkbox: bool = True
    """是否隐藏默认值复选框。当default_value为None时，此选项无效，默认值复选框始终显示。"""

    set_deepcopy: bool = True
    get_deepcopy: bool = True

    description_font_size: Optional[int] = None
    """控件描述文本字体大小。"""

    description_color: Optional[str] = COLOR_REGULAR_TEXT
    """控件描述文本颜色。默认为 `COLOR_REGULAR_TEXT`。"""

    parameter_error_font_size: Optional[int] = None
    """ParameterError文本字体大小。"""

    parameter_error_color: Optional[str] = COLOR_FATAL
    """ParameterError文本颜色。默认为 `COLOR_FATAL`。"""

    highlight_effect: bool = True
    """是否启用高亮效果。当启用高亮效果时，允许开发者高亮显示该控件。"""

    effect_class: Optional[Type[QGraphicsEffect]] = QGraphicsDropShadowEffect
    """高亮效果类。默认为 `QGraphicsDropShadowEffect`。"""

    effect_properties: Optional[dict] = dataclasses.field(
        default_factory=_default_highlight_effect_properties
    )
    """高亮效果属性。默认为 `None`。"""

    drag_n_drop: bool = False
    """是否启用拖放功能。默认为 `False`。"""

    @classmethod
    def target_widget_class(cls) -> Type["CommonParameterWidget"]:
        return CommonParameterWidget

description_color: Optional[str] = COLOR_REGULAR_TEXT class-attribute instance-attribute

控件描述文本颜色。默认为 COLOR_REGULAR_TEXT。

description_font_size: Optional[int] = None class-attribute instance-attribute

控件描述文本字体大小。

drag_n_drop: bool = False class-attribute instance-attribute

是否启用拖放功能。默认为 False。

effect_class: Optional[Type[QGraphicsEffect]] = QGraphicsDropShadowEffect class-attribute instance-attribute

高亮效果类。默认为 QGraphicsDropShadowEffect。

effect_properties: Optional[dict] = dataclasses.field(default_factory=_default_highlight_effect_properties) class-attribute instance-attribute

高亮效果属性。默认为 None。

hide_default_value_checkbox: bool = True class-attribute instance-attribute

是否隐藏默认值复选框。当default_value为None时，此选项无效，默认值复选框始终显示。

highlight_effect: bool = True class-attribute instance-attribute

是否启用高亮效果。当启用高亮效果时，允许开发者高亮显示该控件。

parameter_error_color: Optional[str] = COLOR_FATAL class-attribute instance-attribute

ParameterError文本颜色。默认为 COLOR_FATAL。

parameter_error_font_size: Optional[int] = None class-attribute instance-attribute

ParameterError文本字体大小。

set_default_value_on_init: bool = True class-attribute instance-attribute

是否在控件初始化时设置默认值。默认为 True。

CommonParameterWidget

Bases: BaseParameterWidget

通用参数控件基类。继承自 BaseParameterWidget 类。为所有参数控件定义了基本的布局和整体外观。目前内置控件均继承自此类。

value_widget: QWidget abstractmethod property

返回“值控件”。此为抽象方法，必须在子类中实现。

Returns:

Type Description
QWidget

控件示例。

get_value_from_widget() -> Any abstractmethod

从“值控件”中获取用户当前输入的值。此为抽象方法，必须在子类中实现。

Returns:

Type Description
Any

用户当前输入的值

set_value_to_widget(value: Any) -> None abstractmethod

将用户传入的值设置到“值控件”中。此为抽象方法，必须在子类中实现。

Parameters:

Name Type Description Default
value Any

用户传入的值

 required

Returns:

Type Description
None

无返回值