10.7.3. Class cerebro.gui.ProgressBox

class cerebro.gui.ProgressBox(title, min=0, max=100)

Parameters:

• title (string) – progress window title.
• min (int) – progress minimal value.
• max (int) – progress maximal value.

Progress window class.

Methods

• close()
• hide_cancel_button()
• label()
• max()
• min()
• reset()
• set_label()
• set_range()
• set_title()
• set_value()
• show()
• title()
• value()
• was_canceled()

prgbar = cerebro.gui.ProgressBox('Progress Window', 0, 100)
prgbar.set_label('Progress...')
prgbar.show()
for i in range(0,100):                  
        if prgbar.was_canceled() == True: # checking if the operation hasn't been canceled by user
                break
                
        prgbar.set_value(i)                     
        
prgbar.close()  

close()

Closes a progress window.

See also

show().

hide_cancel_button()

Hides “Cancel” button.

Use this method if you want to prevent users from canceling the operation. If you leave the option to cancel available, you should use the was_canceled() method in order to know if the “Cancel” button was pressed or not.

label()

Returns:text label. Return type:string

See also

set_label().

max()

Returns:maximal progress value. Return type:int

See also

set_range().

min()

Returns:minimal progress value. Return type:int

See also

set_range().

reset()

Resets progress value the minimum.

set_label(label)

Parameters:label (string) – text label.

Sets a text label.

See also

label().

set_range(min, max)

Parameters:

• min (int) – minimal progress value.
• max (int) – maximal progress value.

Sets minimal and maximal progress values.

See also

max(), min().

set_title(title)

Parameters:title (string) – window title.

Sets a progress window title.

See also

title().

set_value(value)

Parameters:value (int) – progress value.

Sets progress value.

See also

value().

show()

Displays a progress window.

See also

close().

title()

Returns:progress window title. Return type:string

See also

set_title().

value()

Returns:progress value. Return type:int

See also

set_value().

was_canceled()

Returns:True, if the user pressed the “Cancel” button. Return type:bool