Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.18 KB

ctl_progress_bar.rst

File metadata and controls

49 lines (33 loc) · 1.18 KB
Raw

Class CtlProgressBar

Introduction

Class for working with progress bar controls in a dialog.

EventArgsCallbackT

All :py:protocol:`~ooodev.utils.type_var.EventArgsCallbackT` callbacks include control_src as a keyword argument.

A callback can be in the format of:

def on_some_event(
    src: Any, event: EventArgs, control_src: CtlProgressBar, *args, **kwargs
) -> None:
    pass

or

def on_some_event(src: Any, event: EventArgs, *args, **kwargs) -> None:
    # can get control from kwargs
    ctl = cast(CtlProgressBar, kwargs['control_src'])

Example

.. cssclass:: screen_shot

    .. image:: https://user-images.githubusercontent.com/4193389/284088573-c2bdf23e-7e3a-4ec0-9844-8a70c0be8bdd.png
        :alt: Progress and Scrollbar Screen Shot
        :align: center

For an example see Progress Bar and Scroll Bar Example

Class

.. autoclass:: ooodev.dialog.dl_control.CtlProgressBar
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members: