跳转至

pyguiadapter.widgets.stringlist

控件配置类

StringListEditConfig dataclass

Bases: CommonParameterWidgetConfig

StringListEdit的配置类。

Source code in pyguiadapter\widgets\extend\stringlist.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 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
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
@dataclasses.dataclass(frozen=True)
class StringListEditConfig(CommonParameterWidgetConfig):
    """StringListEdit的配置类。"""

    default_value: Optional[List[str]] = dataclasses.field(default_factory=list)
    """默认值"""

    empty_string_strategy: Literal["keep_all", "keep_one", "remove_all"] = "remove_all"
    """对待列表中空字符串的策略，keep_all表示保留所有空字符串，keep_one表示只保留第一个空字符串，remove_all表示删除所有空字符串"""

    add_file: bool = True
    """是否开启添加文件路径功能"""

    add_dir: bool = True
    """是否开启添加文件夹路径功能"""

    file_filters: str = ""
    """文件过滤器，用于文件对话框"""

    start_dir: str = ""
    """起始路径，用于文件对话框"""

    normalize_path: bool = True
    """是否将路径规范化"""

    add_button_text: str = "Add"
    """添加按钮文本"""

    remove_button_text: str = "Remove"
    """移除按钮文本"""

    clear_button_text: str = "Clear"
    """清空按钮文本"""

    add_string_hint: str = "Add Text"
    """添加字符串的提示"""

    add_file_hint: str = "Add File"
    """添加文件路径的提示"""

    add_dir_hint: str = "Add Directory"
    """添加文件夹路径的提示"""

    file_dialog_title: str = "Select File"
    """添加文件对话框标题"""

    dir_dialog_title: str = "Select Directory"
    """添加文件夹对话框标题"""

    confirm_dialog_title: str = "Confirm"
    """确认对话框标题"""

    warning_dialog_title: str = "Warning"
    """警告对话框标题"""

    confirm_remove: bool = True
    """是否显示移除确认对话框"""

    confirm_clear: bool = True
    """是否显示清空确认对话框"""

    remove_confirm_message: str = "Are you sure to remove the selected item?"
    """移除确认对话框消息"""

    clear_confirm_message: str = "Are you sure to remove all items?"
    """清空确认对话框消息"""

    no_selection_message: str = "No items are selected!"
    """未选择任何项的提示"""

    drag_enabled: bool = True
    """是否允许拖拽"""

    wrapping: bool = False
    """是否允许换行"""

    text_elide_mode: Optional[TextElideMode] = TextElideMode.ElideNone
    """文本省略模式"""

    alternating_row_colors: bool = True
    """是否使用交替行颜色"""

    width: Optional[int] = None
    """表格的最小宽度"""

    height: Optional[int] = 230
    """表格的最小高度"""

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

add_button_text: str = 'Add' class-attribute instance-attribute

添加按钮文本

add_dir: bool = True class-attribute instance-attribute

是否开启添加文件夹路径功能

add_dir_hint: str = 'Add Directory' class-attribute instance-attribute

添加文件夹路径的提示

add_file: bool = True class-attribute instance-attribute

是否开启添加文件路径功能

add_file_hint: str = 'Add File' class-attribute instance-attribute

添加文件路径的提示

add_string_hint: str = 'Add Text' class-attribute instance-attribute

添加字符串的提示

alternating_row_colors: bool = True class-attribute instance-attribute

是否使用交替行颜色

clear_button_text: str = 'Clear' class-attribute instance-attribute

清空按钮文本

clear_confirm_message: str = 'Are you sure to remove all items?' class-attribute instance-attribute

清空确认对话框消息

confirm_clear: bool = True class-attribute instance-attribute

是否显示清空确认对话框

confirm_dialog_title: str = 'Confirm' class-attribute instance-attribute

确认对话框标题

confirm_remove: bool = True class-attribute instance-attribute

是否显示移除确认对话框

default_value: Optional[List[str]] = dataclasses.field(default_factory=list) class-attribute instance-attribute

默认值

dir_dialog_title: str = 'Select Directory' class-attribute instance-attribute

添加文件夹对话框标题

drag_enabled: bool = True class-attribute instance-attribute

是否允许拖拽

empty_string_strategy: Literal['keep_all', 'keep_one', 'remove_all'] = 'remove_all' class-attribute instance-attribute

对待列表中空字符串的策略，keep_all表示保留所有空字符串，keep_one表示只保留第一个空字符串，remove_all表示删除所有空字符串

file_dialog_title: str = 'Select File' class-attribute instance-attribute

添加文件对话框标题

file_filters: str = '' class-attribute instance-attribute

文件过滤器，用于文件对话框

height: Optional[int] = 230 class-attribute instance-attribute

表格的最小高度

no_selection_message: str = 'No items are selected!' class-attribute instance-attribute

未选择任何项的提示

normalize_path: bool = True class-attribute instance-attribute

是否将路径规范化

remove_button_text: str = 'Remove' class-attribute instance-attribute

移除按钮文本

remove_confirm_message: str = 'Are you sure to remove the selected item?' class-attribute instance-attribute

移除确认对话框消息

start_dir: str = '' class-attribute instance-attribute

起始路径，用于文件对话框

text_elide_mode: Optional[TextElideMode] = TextElideMode.ElideNone class-attribute instance-attribute

文本省略模式

warning_dialog_title: str = 'Warning' class-attribute instance-attribute

警告对话框标题

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

表格的最小宽度

wrapping: bool = False class-attribute instance-attribute

是否允许换行

控件类

StringListEdit

Bases: CommonParameterWidget

ElideLeft = TextElideMode.ElideLeft class-attribute instance-attribute

文本省略模式：省略左边

ElideMiddle = TextElideMode.ElideMiddle class-attribute instance-attribute

文本省略模式：省略中间

ElideNone = TextElideMode.ElideNone class-attribute instance-attribute

文本省略模式：不省略

ElideRight = TextElideMode.ElideRight class-attribute instance-attribute

文本省略模式：省略右边

对应参数数据类型

  • string_list_t