Skip to content

pyguiadapter.windows.fnselect

FnSelectWindowConfig dataclass

Bases: BaseWindowConfig

Source code in pyguiadapter\windows\fnselect\_window.py
@dataclasses.dataclass(frozen=True)
class FnSelectWindowConfig(BaseWindowConfig):
    title: str = "Select Function"
    """窗口标题"""

    size: Union[Tuple[int, int], QSize] = (800, 600)
    """窗口尺寸"""

    select_button_text: str = "Select"
    """选择按钮文字"""

    icon_mode: bool = False
    """函数列表是否启用图标模式"""

    icon_size: Union[Tuple[int, int], int, QSize, None] = DEFAULT_FN_ICON_SIZE
    """函数图标大小"""

    default_fn_group_name: str = "Main Functions"
    """默认函数分组名称"""

    default_fn_group_icon: IconType = None
    """默认函数分组图标"""

    fn_group_icons: Dict[str, IconType] = dataclasses.field(default_factory=dict)
    """其他函数分组图标"""

    document_browser_config: Optional[DocumentBrowserConfig] = None
    """文档浏览器配置"""

    document_browser_width: int = 490
    """文档浏览器宽度"""

default_fn_group_icon: IconType = None class-attribute instance-attribute

默认函数分组图标

default_fn_group_name: str = 'Main Functions' class-attribute instance-attribute

默认函数分组名称

document_browser_config: Optional[DocumentBrowserConfig] = None class-attribute instance-attribute

文档浏览器配置

document_browser_width: int = 490 class-attribute instance-attribute

文档浏览器宽度

fn_group_icons: Dict[str, IconType] = dataclasses.field(default_factory=dict) class-attribute instance-attribute

其他函数分组图标

icon_mode: bool = False class-attribute instance-attribute

函数列表是否启用图标模式

icon_size: Union[Tuple[int, int], int, QSize, None] = DEFAULT_FN_ICON_SIZE class-attribute instance-attribute

函数图标大小

select_button_text: str = 'Select' class-attribute instance-attribute

选择按钮文字

size: Union[Tuple[int, int], QSize] = (800, 600) class-attribute instance-attribute

窗口尺寸

title: str = 'Select Function' class-attribute instance-attribute

窗口标题

FnSelectWindow

Bases: BaseWindow

get_group_names() -> List[str]

获取所有函数分组名称。

Returns:

Type Description
List[str]

返回函数分组名称列表。

get_select_button_text() -> str

获取选择按钮文字。

Returns:

Type Description
str

返回当前选择按钮上的文字。

remove_group(group_name: Optional[str]) -> None

移除指定函数分组。

Parameters:

Name Type Description Default
group_name Optional[str]

待移除的函数分组名称。

required

Returns:

Type Description
None

无返回值

Raises:

Type Description
ValueError

当指定函数分组名称不存在时,将抛出ValueError

set_document_browser_width(width: int) -> None

设置文档浏览器宽度。

Parameters:

Name Type Description Default
width int

目标宽度

required

Returns:

Type Description
None

无返回值

set_select_button_text(text: str) -> None

设置选择按钮文字。

Parameters:

Name Type Description Default
text str

带设置的文字

required

Returns:

Type Description
None

无返回值