Welcome to QGUI’s documentation!¶
qgui package¶
Submodules¶
qgui.base_frame module¶
- class qgui.base_frame.BaseBanner(title: str = 'QGUI测试程序', style='primary')¶
基类：
qgui.base_frame._Backbone- add_tool(tool: qgui.banner_tools.BaseBarTool)¶
添加小工具组件 :param
- build(master, global_info)¶
基类：
qgui.base_frame._Backbone左侧导航栏基本框架
- class qgui.base_frame.BaseNoteBook(style='primary', tab_names: Optional[List[str]] = None, stdout=None)¶
基类：
qgui.base_frame._Backbone中间Notebook部分框架
- add_tool(tool: qgui.notebook_tools.BaseNotebookTool, to_notebook=True)¶
- build(master, global_info)¶
- print_image(image)¶
- print_tool(tool: qgui.notebook_tools.BaseNotebookTool)¶
qgui.base_tools module¶
- class qgui.base_tools.ArgInfo(name=None, set_func=None, get_func=None)¶
基类：
object- get(*args, **kwargs)¶
- get_info()¶
- set(*args, **kwargs)¶
- class qgui.base_tools.BaseTool(bind_func=None, name: Optional[str] = None, style: str = 'primary', async_run: bool = False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
基类：
object基础工具集，提供基础异步Callback 1. 写Build，记得继承才会有self.master，继承时候传**kwargs 2. 若需返回信息，请重写get_info方法->ArgInfo 3. 如绑定func，需要封装Callback
- build(*args, **kwargs) tkinter.Frame¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- qgui.base_tools.check_callable(bind_func)¶
- qgui.base_tools.select_var_dtype(dtype)¶
qgui.factory module¶
- class qgui.factory.CreateQGUI(title='未命名应用', style=None, stout=None, tab_names: Optional[List[str]] = None, banner: Optional[qgui.base_frame.BaseBanner] = None, navigation: Optional[qgui.base_frame.BaseNavigation] = None, notebook: Optional[qgui.base_frame.BaseNoteBook] = None, bind_func=None)¶
基类：
object创建最基础的QGUI程序
- 参数
title – 主程序标题
style – 皮肤，需通过QStyle来确定
stout – 标准输出流
tab_names – List[str] 功能区Tab页面，默认为“主程序控制台”
banner – QGUI的Banner对象
navigation – QGUI的navigation对象
notebook – QGUI的notebook对象
bind_func – 全局事件绑定
- abt(tool: qgui.banner_tools.BaseBarTool)¶
在程序最上方添加小组件 :param tool: 继承于BaseBarTool的组件对象
- Example
from qgui.banner_tools import GitHub q_gui = CreateQGUI() q_gui.add_banner_tool(GitHub())
- add_banner_tool(tool: qgui.banner_tools.BaseBarTool)¶
在程序最上方添加小组件 :param tool: 继承于BaseBarTool的组件对象
- Example
from qgui.banner_tools import GitHub q_gui = CreateQGUI() q_gui.add_banner_tool(GitHub())
- add_notebook_tool(tool: qgui.notebook_tools.BaseNotebookTool)¶
在程序中央功能区添加小组件 :param tool: 继承于BaseNotebookTool的组件对象
- Example
from qgui.notebook_tools import RunButton q_gui.add_notebook_tool(RunButton())
- ant(tool: qgui.notebook_tools.BaseNotebookTool)¶
在程序中央功能区添加小组件 :param tool: 继承于BaseNotebookTool的组件对象
- Example
from qgui.notebook_tools import RunButton q_gui.add_notebook_tool(RunButton())
- property get_global_info¶
- print_image(image)¶
在终端中打印图像 :param image: 图像所在路径 or pillow图片对象
- print_tool(tool: qgui.notebook_tools.BaseNotebookTool)¶
在终端中打印组件 :param tool: 继承于BaseNotebookTool的组件对象
- run()¶
展示GUI界面
设置左侧导航栏的程序基本信息 :param author: 作者 :param version: 版本号 :param github_url: GitHub链接
设置左侧导航栏其他信息 :param title: 标题 :param info: 信息
- sna(author: str = '未知作者', version: str = '0.0.1', github_url: Optional[str] = None, other_info: Optional[List[str]] = None)¶
设置左侧导航栏的程序基本信息 :param author: 作者 :param version: 版本号 :param github_url: GitHub链接
- sni(title: str, info: str)¶
设置左侧导航栏其他信息 :param title: 标题 :param info: 信息
qgui.manager module¶
- class qgui.manager.MessageBox¶
基类：
object- static error(text: str, title: str = '错误 - QGUI')¶
- static info(text: str, title: str = '消息 - QGUI')¶
- static warning(text: str, title: str = '警告 - QGUI')¶
- qgui.manager.show_file_or_path(path, return_func=True)¶
qgui.notebook_tools module¶
- class qgui.notebook_tools.BaseButton(bind_func, name: Optional[str] = None, text: str = '开始执行', icon: Optional[str] = None, checked_text: Optional[str] = None, async_run: bool = True, style: str = 'primary', tab_index: int = 0, concurrency_mode: bool = False, add_width=8)¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(**kwargs) tkinter.Frame¶
- class qgui.notebook_tools.BaseCheckButton(options: str, bind_func=None, name=None, title='请选择', style='primary', button_style='TCheckbutton', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件', mode=None)¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(*args, **kwargs)¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- class qgui.notebook_tools.BaseChooseFileTextButton(bind_func=None, name: Optional[str] = None, label_info: str = '目标文件路径', entry_info: str = '请选择文件路径', button_info: str = '选 择 文 件 ', style: str = 'primary', tab_index: int = 0, async_run: bool = False, mode='file')¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(**kwargs) tkinter.Frame¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- class qgui.notebook_tools.BaseCombine(tools: qgui.notebook_tools.BaseNotebookTool, side='Horizontal水平方向', title=None, style: Optional[str] = None, tab_index: Optional[int] = None)¶
基类：
qgui.notebook_tools.BaseNotebookTool- get_arg_info() qgui.base_tools.ArgInfo¶
- class qgui.notebook_tools.BaseFrameCombine(tools: qgui.notebook_tools.BaseNotebookTool, side='Horizontal水平方向', title=None, style: Optional[str] = None, tab_index: Optional[int] = None)¶
基类：
qgui.notebook_tools.BaseCombine- build(*args, **kwargs)¶
- class qgui.notebook_tools.BaseNotebookTool(bind_func=None, name: Optional[str] = None, style: str = 'primary', tab_index: int = 0, async_run: bool = False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
-
基础Notebook工具集，提供基础异步Callback 1. 写Build，记得继承才会有self.master，继承时候传**kwargs 2. 若需返回信息，请重写get_info方法->ArgInfo 3. 如绑定func，需要封装Callback
- class qgui.notebook_tools.BaseRadioButton(options: str, default: Optional[str] = None, bind_func=None, name=None, title='请选择', style='primary', button_style='TRadiobutton', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件', mode=None)¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(*args, **kwargs)¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- class qgui.notebook_tools.CheckButton(options: str, bind_func=None, name=None, title='请选择', style='primary', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.CheckObviousToolButton(options: str, bind_func=None, name=None, title='请选择', style='primary', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.CheckToolButton(options: str, bind_func=None, name=None, title='请选择', style='info', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.ChooseDirTextButton(bind_func=None, name=None, label_info: str = '目标文件夹路径', entry_info: str = '请选择文件夹路径', button_info: str = '选择文件夹', style: str = 'primary', tab_index: int = 0, async_run: bool = False)¶
- class qgui.notebook_tools.ChooseFileTextButton(bind_func=None, name: Optional[str] = None, label_info: str = '目标文件路径', entry_info: str = '请选择文件路径', button_info: str = '选 择 文 件', filetypes: Optional[bool] = None, style: str = 'primary', tab_index: int = 0, async_run: bool = False)¶
- class qgui.notebook_tools.Combobox(bind_func=None, name=None, title: str = '请下拉选择', options: Optional[List[str]] = None, style='custom', tab_index=0)¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(**kwargs)¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- class qgui.notebook_tools.HorizontalFrameCombine(tools: qgui.notebook_tools.BaseNotebookTool, title=None, style: Optional[str] = None, tab_index: int = 0)¶
- class qgui.notebook_tools.HorizontalToolsCombine(tools: qgui.notebook_tools.BaseNotebookTool, title=None, style: Optional[str] = None, tab_index: Optional[int] = None)¶
基类：
qgui.notebook_tools.BaseCombine- build(*args, **kwargs)¶
- class qgui.notebook_tools.InputBox(name=None, default='请在此输入', label_info='输入信息', style='primary', tab_index=0)¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(**kwargs)¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- class qgui.notebook_tools.Progressbar(title: str = '进度条', default: int = 0, max_size: int = 100, name: Optional[str] = None, style: str = 'primary', tab_index: int = 0, async_run: bool = False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(*args, **kwargs)¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- progressbar_var_trace(*args)¶
- class qgui.notebook_tools.RadioButton(options: str, default: Optional[str] = None, bind_func=None, name=None, title='请选择', style='primary', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.RadioObviousToolButton(options: str, default: Optional[str] = None, bind_func=None, name=None, title='请选择', style='primary', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.RadioToolButton(options: str, default: Optional[str] = None, bind_func=None, name=None, title='请选择', style='info', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.RunButton(bind_func, name: Optional[str] = None, text: str = '开始执行', checked_text: str = '正在执行', async_run: bool = True, style: str = 'success', tab_index: int = 0, concurrency_mode: bool = False)¶
- class qgui.notebook_tools.Slider(name=None, title: str = '请拖动滑块', default: int = 0, min_size: int = 0, max_size: int = 100, dtype=<class 'int'>, style='primary', tab_index=0)¶
基类：
qgui.notebook_tools.BaseNotebookTool- build(**kwargs)¶
- get_arg_info() qgui.base_tools.ArgInfo¶
- slider_var_trace(*args)¶
- class qgui.notebook_tools.ToggleButton(options: str, bind_func=None, name=None, title='请选择', style='primary', tab_index=0, async_run=False, concurrency_mode='不允许并发，禁止触发下一个事件')¶
- class qgui.notebook_tools.VerticalFrameCombine(tools: qgui.notebook_tools.BaseNotebookTool, title=None, style: Optional[str] = None, tab_index: int = 0)¶