ui.components.accountprogress

Module Contents

Classes

CustomIcon	Icon class.
ProgressPopup	Card class.
ProgressItem	RelativeLayout class, see module documentation for more information.
AccountProgress	This mixin class provides

class ui.components.accountprogress.CustomIcon(*args, **kwargs)

Bases: kivymd.uix.label.MDIcon, kivymd.uix.behaviors.RotateBehavior

Icon class.

For more information, see in the MDLabel and MDFloatLayout classes documentation.

class ui.components.accountprogress.ProgressPopup(*args, parent_container, **kwargs)

Bases: kivymd.uix.card.MDCard

Card class.

For more information, see in the DeclarativeBehavior and MDAdaptiveWidget and ThemableBehavior and BackgroundColorBehavior and RectangularRippleBehavior and CommonElevationBehavior and FocusBehavior and BoxLayout and classes documentation.

parent_container

Stores the popup object

class ui.components.accountprogress.ProgressItem(**kw)

Bases: kivy.uix.relativelayout.RelativeLayout

RelativeLayout class, see module documentation for more information.

task_name

task_thread

task_progress

task_max

event

cancel_task()

Cancels the task

class ui.components.accountprogress.AccountProgress(**kw)

Bases: kivy.uix.behaviors.ButtonBehavior, kivy.uix.floatlayout.FloatLayout, kivymd.theming.ThemableBehavior

This mixin class provides Button behavior. Please see the button behaviors module documentation for more information.

Events:

on_press

Fired when the button is pressed.

on_release

Fired when the button is released (i.e. the touch/click that pressed the button goes away).

loading

tasks

List of tasks to be completed. Stores the task name and its current state. Acts as the reference for all tasks

popup

Stores the popup object

popup_shown

Stores whether the popup is shown or not

overall_progress

on_touch_down(touch)

Receive a touch down event.

Parameters:

touch: MotionEvent class

Touch received. The touch is in parent coordinates. See relativelayout for a discussion on coordinate systems.

Returns:

bool If True, the dispatching of the touch event will stop. If False, the event will continue to be dispatched to the rest of the widget tree.

on_loading(*args)

Called when the loading property is changed

check_if_can_add_task(task_name: str)

Checks if a task can be added to the list of tasks

add_task(task: ast.Dict)

Adds a task to the list of tasks

get_task(name: str)

Gets a task from the list of tasks

update_task(name: str, progress: int, max: int)

Updates a task progress in the list of tasks

on_tasks(*args)

Used to update the summary progress UI

on_release()

Opens menu to show progress of tasks

open_menu()

close_menu()

Closes the menu

clear_finished_tasks()

Clears all the finished tasks

cancel_all_tasks()

Cancels all the tasks