进度条与进度对话框

进度条

（一）概述

PyGUIAdapter提供了进度条功能，开发者可以在函数执行过程中显示、隐藏和更新进度条。

进度条位于函数执行窗口Ouput Dock中，在输出浏览器下方，主要包括三个部分：

• Progress Bar：进度条本体。

• Message：进度条上显示的进度信息。

• Info：额外显示的信息。

相关的API在pyguiadapter.adapter.uprogress模块中，主要包含以下三个接口：

• show_progressbar()：用于显示进度条。

• hide_progressbar()：用于隐藏进度条。

• update_progress()：用于更新进度信息和额外显示的信息。

各个函数具体信息可以参考以下文档：

• pyguiadapter.adapter.uprogress

（二）示例

import time

from pyguiadapter.adapter import GUIAdapter, udialog
from pyguiadapter.adapter import uprogress
from pyguiadapter.adapter.ucontext import is_function_cancelled
from pyguiadapter.adapter.uoutput import uprint


def progressbar_example(total: int = 100, delay: float = 0.5):
    """
    example for **progressbar** and **cancellable function**

    @param total: how many task will be processed
    @param delay: how much time will be consumed per task
    @return:
    """
    uprogress.show_progressbar(0, total, message_visible=True)
    cancelled = False
    task_processed = 0
    for i in range(total):
        if is_function_cancelled():
            uprint("Cancelled!")
            cancelled = True
            break
        task_processed = i + 1
        uprint(f"[Processed] {task_processed}")
        uprogress.update_progress(
            task_processed, info=f"[{task_processed}/{total}] please wait..."
        )
        time.sleep(delay)
    if cancelled:
        udialog.show_warning_messagebox(
            f"{task_processed} task(s) processed!", title="Cancelled"
        )
    else:
        udialog.show_info_messagebox(
            f"{task_processed} task(s) processed!", title="Completed"
        )
    uprogress.hide_progressbar()


if __name__ == "__main__":
    adapter = GUIAdapter()
    adapter.add(progressbar_example, cancelable=True)
    adapter.run()

效果如下：

---

进度对话框

（一）概述

除了集成在Ouput Dock中的进度条，PyGUIAdapter还提供了独立进度对话框功能，开发者可以在函数执行过程中显示、隐藏和更新进度对话框。

进度对话框主要包括以下四个部分：

• Progress Bar：进度条。

• Message：进度条上显示的进度信息。

• Info：额外显示的信息。

• Cancel Button：取消按钮。仅在function被标记为cancelable=True时显示。与执行窗口界面上的取消按钮功能一致，用于请求取消当前正在执行的函数。

相关的API在pyguiadapter.adapter.uprogress模块中，主要包含以下三个接口：

• show_progress_dialog()：用于显示进度对话框。

• dismiss_progress_dialog()：用于取消进度对话框。

• update_progress_dialog()：用于更新进度对话框中进度条的进度信息和额外显示的信息。

各个函数具体信息可以参考以下文档：

• pyguiadapter.adapter.uprogress

（二）示例

import time

from pyguiadapter.adapter import GUIAdapter, udialog
from pyguiadapter.adapter import uprogress
from pyguiadapter.adapter.ucontext import is_function_cancelled
from pyguiadapter.adapter.uoutput import uprint


def progress_dialog_example(total: int = 100, delay: float = 0.5):
    """
    An example for **progress dialog** features

    @param total: how many task will be processed
    @param delay: how much time will be consumed per task
    @return:
    """
    cancelled = False
    task_processed = 0
    # use this function to show a progress dialog
    uprogress.show_progress_dialog(
        0, total, message_visible=True, info_visible=True, modal=False
    )
    for i in range(total):
        if is_function_cancelled():
            uprint("Cancelled!")
            cancelled = True
            break
        task_processed = i + 1
        uprint(f"[Processed] {task_processed}")
        # use this function to update the progressbar and info message in the progress dialog
        uprogress.update_progress_dialog(
            task_processed, info=f"[{task_processed}/{total}] please wait..."
        )
        time.sleep(delay)
    if cancelled:
        udialog.show_warning_messagebox(
            f"{task_processed} task(s) processed!", title="Cancelled"
        )
    else:
        udialog.show_info_messagebox(
            f"{task_processed} task(s) processed!", title="Completed"
        )
    # use this function to dismiss the progress dialog after the task is done
    uprogress.dismiss_progress_dialog()


if __name__ == "__main__":
    adapter = GUIAdapter()
    adapter.add(progress_dialog_example, cancelable=True)
    adapter.run()

效果如下：