核心类
核心功能API,可通过实例化后调用相关的API。
# 创建实例化对象
app = IDEPY("App", main_window_config)
# 检查当前设备是否支持edgechroium内核,不支持则提示升级
app.check_support_and_update_edgechromium()
# 任意位置获取app实例
from idepy.core.main import get_app
get_app()
更多的功能方法介绍如下:
IDEPY
init
实例化 IDEPY 对象,并立马创建
app_name: 应用名称,程序开机自启使用的文件名,如idepy,则自启使用idepy.exe
main_window_config: 主窗口的配置项,与pywebview一致
create_tk_thread: 创建tkinter相关线程,用于弹窗、文件选择等,默认为True
create_main_window_now: 立即创建主窗口,默认为True
init_main_window
当初始化IDEPY实例时,如果create_main_window_now设为False,那么可以调用该函数创建主窗口。
create_window
创建window窗口,参数与pywebview create_window参数一致。
start
启动应用主线程,参数与pywebview start的参数一致。
set_auto_start
设置应用开机自动启动
enabled: 设置开机启动程序自身,True为设置,False为取消。
is_enabled_auto_start
检查程序是否开机启动
return: bool
hotkeys_reg
注册全局热键
key:按键,组合键为:alt+ctrl+h、单按键为:h
oncall: 热键触发函数
suppress: 当本程序触发热键时,其他项目不触发热键
hotkeys_list
获取组成的热键
return: list 注册的热键列表
tray_start
启动托盘图标
name: 托盘名称
icon_path: 图标目录
menu_list:菜单项目 [{ text: Any,action: Any}],text为菜单项名称,action为对应的回调函数。
tray_stop
关闭托盘图标
show_notify
显示系统通知,仅Window系统可用。
title: 标题
msg: 信息
duration: 持续时间默认10s
show_message_box_draw
显示消息框,使用单独窗口绘制
message: 提示消息
title: 提示标题
height: 高度
width: 宽度
block: 是否阻塞,等待用户关闭后执行操作
show_message_box_draw_by_js
1.13.8版本后支持
显示消息框,使用单独窗口绘制,纯原生+Jinjia2实现,由于加载的内容更少,执行效率比show_message_box_draw更高。
如果旧项目没有相关内容,可以到idepy/templates/base_project/static/src/window_sys/message_js目录复制到项目的window_sys文件夹。
message: 提示消息
title: 提示标题
height: 高度
width: 宽度
block: 是否阻塞,等待用户关闭后执行操作
config_get
获取程序配置项
key_path: 配置项的键
default: 返回默认值
config_data
获取程序配置项
config_update
更新程序配置项
key_path: 配置项键,如base.time
value: 对应项的值
file_select_folder_path
弹出对话框,让用户选择一个文件夹地址
参数项与tkinter的filedialog.askdirectory函数一致
:return: 文件夹路径
file_select_file_path
弹出对话框,让用户选择一个文件地址
参数项与tkinter的filedialog.askopenfilename函数一致
:return: 文件路径
file_select_file_save_path
弹出对话框,让用户选择一个文件地址
参数项与tkinter的filedialog.asksaveasfilename函数一致
:return: 文件路径
check_support_and_update_edgechromium
检查是否支持edgechromium,并提示更新,强制退出程序
:return: 文件路径
set_jinjia_data
1.13.8版本后支持
设置jinjia模板的数据,需要页面刷新后才生效
template_path_or_jinjia_id 输入模板文件的目录,如:/windows/window1/index.html,开头和连接符使用/,且相对于static/src目录的路径,或jinjia模板id。
data 设置的数据值
get_jinjia_data
1.13.8版本后支持
获取jinjia模板的数据
template_path_or_jinjia_id 输入模板文件的目录,如:/windows/window1/index.html,使用反斜杠,且相对于static/src目录的路径,或jinjia模板id。
remove_jinjia_data
1.13.8版本后支持
移除jinjia模板的数据
template_path_or_jinjia_id 输入模板文件的目录,如:/windows/window1/index.html,使用反斜杠,且相对于static/src目录的路径,或jinjia模板id。