跳转至

pyguiadapter.action

Action dataclass

Bases: object

该类用于创建动作（Action），在工具栏（ToolBar）中一个Action代表一个工具栏按钮，在菜单（Menu）中，一个Action代表一个菜单项。

Source code in pyguiadapter\action.py 
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
@dataclasses.dataclass
class Action(object):
    """该类用于创建动作（`Action`），在工具栏（`ToolBar`）中一个`Action`代表一个工具栏按钮，在菜单（`Menu`）中，一个`Action`代表一个菜单项。"""

    text: str
    """动作（`Action`）的描述性文本。"""

    on_triggered: Optional[ActionTriggeredCallback] = None
    """回调函数，在动作（`Action`）被触发时回调。"""

    on_toggled: Optional[ActionToggledCallback] = None
    """回调函数，在动作（`Action`）的`checked`状态发生切换时回调。"""

    icon: IconType = None
    """动作（`Action`）的图标。"""

    icon_text: Optional[str] = None
    """动作（`Action`）的图标文本。"""

    auto_repeat: bool = True
    """此属性表示动作（`Action`）是否可以自动重复。如果设置为`True`，并且系统启用了键盘自动重复功能，那么当用户持续按下键盘快捷键组合时，该动作将自动重复。"""

    enabled: bool = True
    """动作（`Action`）是否处于启用状态。"""

    checkable: bool = False
    """动作（`Action`）是否为**`可选中动作`**。`可选中动作`具有`选中`和`未选中`两种状态，在状态发生切换时，将触发`on_toggled`回调函数。"""

    checked: bool = False
    """动作（`Action`）是否处于`选中`状态。"""

    shortcut: Optional[str] = None
    """动作（`Action`）的快捷键。"""

    shortcut_context: Optional[ShortcutContext] = None
    """动作（`Action`）快捷键的上下文。"""

    tooltip: Optional[str] = None
    """动作（`Action`）的工具提示，工具提示是在用户将鼠标悬停在动作上时显示的额外信息。"""

    whats_this: Optional[str] = None
    """动作（`Action`）的“What’s This?” 帮助文本。"""

    status_tip: Optional[str] = None
    """动作（`Action`）的状态提示文本，状态提示文本将显示在动作所在窗口的状态栏中。"""

    priority: Optional[Priority] = None
    """动作（`Action`）在用户界面的优先级。"""

    menu_role: Optional[MenuRole] = None
    """动作（`Action`）菜单角色（menu role）。在macOS应用程序菜单中，每个动作都有一个角色，该角色指示了动作在菜单中的用途。默认情况下，所有动作
    都具有TextHeuristicRole角色，这意味着动作是根据其文本内容被添加到菜单中的"""

    data: Optional[object] = None
    """用户自定义数据。"""

auto_repeat: bool = True class-attribute instance-attribute

此属性表示动作（Action）是否可以自动重复。如果设置为True，并且系统启用了键盘自动重复功能，那么当用户持续按下键盘快捷键组合时，该动作将自动重复。

checkable: bool = False class-attribute instance-attribute

动作（Action）是否为可选中动作。可选中动作具有选中和未选中两种状态，在状态发生切换时，将触发on_toggled回调函数。

checked: bool = False class-attribute instance-attribute

动作（Action）是否处于选中状态。

data: Optional[object] = None class-attribute instance-attribute

用户自定义数据。

enabled: bool = True class-attribute instance-attribute

动作（Action）是否处于启用状态。

icon: IconType = None class-attribute instance-attribute

动作（Action）的图标。

icon_text: Optional[str] = None class-attribute instance-attribute

动作（Action）的图标文本。

menu_role: Optional[MenuRole] = None class-attribute instance-attribute

动作（Action）菜单角色（menu role）。在macOS应用程序菜单中，每个动作都有一个角色，该角色指示了动作在菜单中的用途。默认情况下，所有动作 都具有TextHeuristicRole角色，这意味着动作是根据其文本内容被添加到菜单中的

on_toggled: Optional[ActionToggledCallback] = None class-attribute instance-attribute

回调函数，在动作（Action）的checked状态发生切换时回调。

on_triggered: Optional[ActionTriggeredCallback] = None class-attribute instance-attribute

回调函数，在动作（Action）被触发时回调。

priority: Optional[Priority] = None class-attribute instance-attribute

动作（Action）在用户界面的优先级。

shortcut: Optional[str] = None class-attribute instance-attribute

动作（Action）的快捷键。

shortcut_context: Optional[ShortcutContext] = None class-attribute instance-attribute

动作（Action）快捷键的上下文。

status_tip: Optional[str] = None class-attribute instance-attribute

动作（Action）的状态提示文本，状态提示文本将显示在动作所在窗口的状态栏中。

text: str instance-attribute

动作（Action）的描述性文本。

tooltip: Optional[str] = None class-attribute instance-attribute

动作（Action）的工具提示，工具提示是在用户将鼠标悬停在动作上时显示的额外信息。

whats_this: Optional[str] = None class-attribute instance-attribute

动作（Action）的“What’s This?” 帮助文本。

Separator dataclass

Bases: object

代表了一个分割符，开发者可以用其来分割工具栏上和菜单栏上的动作（Action）

Source code in pyguiadapter\action.py 
101
102
103
104
105
@dataclasses.dataclass(frozen=True)
class Separator(object):
    """代表了一个分割符，开发者可以用其来分割工具栏上和菜单栏上的动作（`Action`）"""

    pass

类型与常量

ActionTriggeredCallback = Callable[[BaseWindow_, Action_], None] module-attribute

ActionToggledCallback = Callable[[BaseWindow_, Action_, bool], None] module-attribute

Priority = QAction.Priority module-attribute

HighPriority = QAction.HighPriority module-attribute

NormalPriority = QAction.NormalPriority module-attribute

LowPriority = QAction.LowPriority module-attribute

MenuRole = QAction.MenuRole module-attribute

NoRole = QAction.NoRole module-attribute

TextHeuristicRole = QAction.TextHeuristicRole module-attribute

ApplicationSpecificRole = QAction.ApplicationSpecificRole module-attribute

AboutQtRole = QAction.AboutQtRole module-attribute

AboutRole = QAction.AboutRole module-attribute

PreferencesRole = QAction.PreferencesRole module-attribute

QuitRole = QAction.QuitRole module-attribute

ShortcutContext = Qt.ShortcutContext module-attribute

WidgetShortcut = Qt.WidgetShortcut module-attribute

WidgetWithChildrenShortcut = Qt.WidgetWithChildrenShortcut module-attribute

WindowShortcut = Qt.WindowShortcut module-attribute

ApplicationShortcut = Qt.ApplicationShortcut module-attribute