整理 PySimpleGUI 官方网站
原文google翻译过来的
https://pysimplegui.readthedocs.io/en/latest/
您将找到有关Elements的信息,所有其他类和函数都位于本手册结尾处。它们位于自述文件的大部分中,按字母顺序排列以便于查找。本节对Elements的讨论旨在教您如何工作。另一部分包含详细的呼叫签名和参数定义。
InputText 元素
Display a single text input field. Based on the tkinter Widget `Entry`
InputText(default_text="",
size=(None, None),
disabled=False,
password_char="",
justification=None,
background_color=None,
text_color=None,
font=None,
tooltip=None,
change_submits=False,
enable_events=False,
do_not_clear=True,
key=None,
focus=False,
pad=None,
use_readonly_for_disable=True,
right_click_menu=None,
visible=True,
metadata=None)
参数说明:
参数类型 | 参数名 | 说明 | ||
---|---|---|---|---|
str | 力量 | str | default_text | 文本最初在输入框中显示为默认值(默认值=”) |
Tuple[int, int] (width, height) | 元组[int,int](宽度,高度) | Tuple[int, int] (width, height) | 尺寸 | w =字符宽,h =行高 |
bool | 布尔 | bool | 残障人士 | 设置元素的禁用状态(默认= False) |
char | 烧焦 | char | password_char | 密码字符(如果这是密码字段)(默认值=”) |
str | 力量 | str | 理由 | 数据显示的理由。有效选择-左,右,中 |
str | 力量 | str | 背景颜色 | 采用一种颜色格式的背景色 |
str | 力量 | str | text_color | 文字颜色 |
Union[str, Tuple[str, int]] | 联合[str,元组[str,int]] | Union[str, Tuple[str, int]] | 字形 | 指定字体系列,大小等 |
str | 力量 | str | 工具提示 | 鼠标悬停在元素上时显示的文本 |
bool | 布尔 | bool | change_submits | *请勿使用!与enable_events相同 |
bool | 布尔 | bool | enable_events | 如果为True,则对此元素的更改将立即报告为事件。使用它代替change_submits(默认= False) |
bool | 布尔 | bool | do_not_clear | 如果为False,则在发生任何事件(按钮,任何事件)之后,该字段都将设置为空白(默认= True) |
any | 任何 | any | 键 | 从所有其他元素中唯一标识此元素的值。查找元素或返回值时使用。窗口必须是唯一的 |
bool | 布尔 | bool | 焦点 | 确定是否应将初始焦点放在该元素上。 |
(int, int) or ((int, int),(int,int)) or (int,(int,int)) or ((int, int),int) | (int,int)或((int,int),(int,int))或(int,(int,int))或((int,int),int) | (int, int) or ((int, int),(int,int)) or (int,(int,int)) or ((int, int),int) | 垫 | 。元素周围的填充量。通常(水平像素,垂直像素),但可以进一步分为((水平左侧,水平右侧),(垂直上方,垂直下方)) |
bool | 布尔 | bool | use_readonly_for_disable | 如果为True(默认),则tkinter状态设置为“只读”。否则状态设置为“禁用” |
List[List[Union[List[str],str]]] | List [List [Union [List [str],str]]] | List[List[Union[List[str],str]]] | right_click_menu | 右键单击此元素时显示的菜单项列表的列表。有关详细格式,请参见用户文档。 |
bool | 布尔 | bool | 可见 | 设置元素的可见性状态(默认= True) |
Any | 任何 | Any | 元数据 | 可以设置为任何内容的用户元数据 |
得到
返回此复选框的当前状态
Get()
参数类型 | 参数名 | 说明 |
---|---|---|
— | 返回 | 输入字段的当前值;如果遇到错误,则为“’’ |
— | return | Current state of checkbox |
设定焦点
将当前焦点设置在此元素上
SetFocus(force=False)
参数说明:
参数类型 | 参数名 | 说明 |
---|---|---|
布尔 | 力 | 如果为True,则将调用focus_force;否则,将调用focus_set |
bool | force | if True will call focus_force otherwise calls focus_set |
设定工具提示
由应用程序调用以更改元素的工具提示文本。通常使用Element Object调用,例如:window.Element(‘key’)。SetToolTip(‘New tip’)。
SetTooltip(tooltip_text)
参数说明:
参数类型 | 参数名 | 说明 |
---|---|---|
力量 | tooltip_text | 要在工具提示中显示的文本。 |
str | tooltip_text | the text to show in tooltip. |
更新资料
更改输入元素的某些设置。必须致电Window.Read或Window.Finalize事先
Update(value=None,
disabled=None,
select=None,
visible=None,
text_color=None,
background_color=None,
move_cursor_to="end")
参数说明:
参数类型 | 参数名 | 说明 | ||
---|---|---|---|---|
str | 力量 | str | 值 | 新文本显示为“输入”字段中的默认文本 |
bool | 布尔 | bool | 残障人士 | 禁用或启用元素的状态(将Entry Widget设置为readonly或normal) |
bool | 布尔 | bool | 选择 | 如果为True,则将选择文本 |
bool | 布尔 | bool | 可见 | 更改元素的可见性 |
str | 力量 | str | text_color | 更改输入文字的颜色 |
str | 力量 | str | 背景颜色 | 更改背景颜色 |
Union[int, str] | 联合[int,str] | Union[int, str] | move_cursor_to | 将光标移动到特定的偏移量。默认为“结束” |
捆绑
用于将tkinter事件添加到Element。tkinter特定数据位于Element的成员变量user_bind_event中
bind(bind_string, key_modifier)
扩大
使元素扩展以填充X和Y方向上的可用空间。可以指定哪个或两个方向
expand(expand_x=False,
expand_y=False,
expand_row=True)
得到
返回此复选框的当前状态
Get()
参数类型 | 参数名 | 说明 |
---|---|---|
— | 返回 | 输入字段的当前值;如果遇到错误,则为“’’ |
— | return | Current state of checkbox |
get_size
返回像素的大小。必须小心,因为某些元素使用字符来指定其大小,但是在调用此get_size方法时将返回像素。
get_size()
参数类型 | 参数名 | 说明 |
---|---|---|
— | 返回 | 元素的宽度和高度 |
— | return | width and height of the element |
hide_row
隐藏元素所在的整行。如果在隐藏元素(包括行容器)时必须删除所有空间,请使用此选项
hide_row()
set_cursor
设置当前元素的光标。
set_cursor(cursor)
set_focus
将当前焦点设置在此元素上
set_focus(force=False)
参数说明:
参数类型 | 参数名 | 说明 |
---|---|---|
— | 返回 | 当前显示在按钮上的文本 |
布尔 | 力 | 如果为True,则将调用focus_force;否则,将调用focus_set |
bool | force | if True will call focus_force otherwise calls focus_set |
set_size
将元素的大小更改为特定大小。可以为其中一种尺寸指定“无”,以便仅更改元素尺寸之一。
set_size(size=(None, None))
参数说明:
参数类型 | 参数名 | 说明 |
---|---|---|
元组[int,int] | 尺寸 | 字符大小,通常为行。在某些情况下,它们是像素 |
Tuple[int, int] | size | The size in characters, rows typically. In some cases they are pixels |
set_tooltip
由应用程序调用以更改元素的工具提示文本。通常使用Element Object调用,例如:window.Element(‘key’)。SetToolTip(‘New tip’)。
set_tooltip(tooltip_text)
参数说明:
参数类型 | 参数名 | 说明 |
---|---|---|
力量 | tooltip_text | 要在工具提示中显示的文本。 |
str | tooltip_text | the text to show in tooltip. |
解除绑定
从Element中移除先前绑定的tkinter事件。
unbind(bind_string)
unhide_row
取消隐藏(再次显示)Element所在的行容器。请注意,它很可能会重新出现在窗口/容器的底部。
unhide_row()
更新
更改输入元素的某些设置。必须致电Window.Read或Window.Finalize事先
update(value=None,
disabled=None,
select=None,
visible=None,
text_color=None,
background_color=None,
move_cursor_to="end")
参数说明:
参数类型 | 参数名 | 说明 | ||
---|---|---|---|---|
str | 力量 | str | 值 | 新文本显示为“输入”字段中的默认文本 |
bool | 布尔 | bool | 残障人士 | 禁用或启用元素的状态(将Entry Widget设置为readonly或normal) |
bool | 布尔 | bool | 选择 | 如果为True,则将选择文本 |
bool | 布尔 | bool | 可见 | 更改元素的可见性 |
str | 力量 | str | text_color | 更改输入文字的颜色 |
str | 力量 | str | 背景颜色 | 更改背景颜色 |
Union[int, str] | 联合[int,str] | Union[int, str] | move_cursor_to | 将光标移动到特定的偏移量。默认为“结束” |