Robot Framework Integrated Development Environment (RIDE)
robotide.contrib.testrunner.testrunnerplugin.ProgressBar Class Reference

A progress bar for the test runner plugin. More...

Inheritance diagram for robotide.contrib.testrunner.testrunnerplugin.ProgressBar:

Public Member Functions

def __init__ (self, parent, fail_color='#FF8E8E', pass_color="#9FCC9F", skip_color='yellow')
 
def add_fail (self)
 Add one to the failed count. More...
 
def add_pass (self)
 Add one to the passed count. More...
 
def add_skip (self)
 Add one to the skipped count. More...
 
def empty_current_keyword (self)
 
def get_visible_color (self, color)
 
def OnTimer (self, event)
 A handler for timer events; it updates the statusba. More...
 
def set_current_keyword (self, name)
 
def Start (self)
 Signals the start of a test run; initialize progressbar. More...
 
def Stop (self)
 Signals the end of a test run. More...
 

Public Attributes

 fail_color
 
 pass_color
 
 skip_color
 

Private Member Functions

def _get_current_keyword_text (self)
 
def _initialize_state (self)
 
def _update_message (self)
 Update the displayed elapsed time, passed and failed counts. More...
 

Static Private Member Functions

def _fix_size (text, max_length)
 
def _seconds_to_string (t)
 Convert a number of seconds to a string of the form HH:MM:SS. More...
 

Private Attributes

 _current_keywords
 
 _default_colour
 
 _fail
 
 _foreground_colour
 
 _gauge
 
 _label
 
 _pass
 
 _sizer
 
 _skip
 
 _start_time
 
 _timer
 

Detailed Description

A progress bar for the test runner plugin.

Definition at line 1156 of file testrunnerplugin.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.__init__ (   self,
  parent,
  fail_color = '#FF8E8E',
  pass_color = "#9FCC9F",
  skip_color = 'yellow' 
)

Definition at line 1158 of file testrunnerplugin.py.

Member Function Documentation

◆ _fix_size()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar._fix_size (   text,
  max_length 
)
staticprivate

Definition at line 1263 of file testrunnerplugin.py.

◆ _get_current_keyword_text()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar._get_current_keyword_text (   self)
private

Definition at line 1256 of file testrunnerplugin.py.

◆ _initialize_state()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar._initialize_state (   self)
private

Definition at line 1177 of file testrunnerplugin.py.

◆ _seconds_to_string()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar._seconds_to_string (   t)
staticprivate

Convert a number of seconds to a string of the form HH:MM:SS.

Definition at line 1273 of file testrunnerplugin.py.

◆ _update_message()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar._update_message (   self)
private

Update the displayed elapsed time, passed and failed counts.

Definition at line 1237 of file testrunnerplugin.py.

◆ add_fail()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.add_fail (   self)

Add one to the failed count.

Definition at line 1216 of file testrunnerplugin.py.

◆ add_pass()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.add_pass (   self)

Add one to the passed count.

Definition at line 1212 of file testrunnerplugin.py.

◆ add_skip()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.add_skip (   self)

Add one to the skipped count.

Definition at line 1220 of file testrunnerplugin.py.

◆ empty_current_keyword()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.empty_current_keyword (   self)

Definition at line 1186 of file testrunnerplugin.py.

◆ get_visible_color()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.get_visible_color (   self,
  color 
)

Definition at line 1223 of file testrunnerplugin.py.

◆ OnTimer()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.OnTimer (   self,
  event 
)

A handler for timer events; it updates the statusba.

Definition at line 1191 of file testrunnerplugin.py.

◆ set_current_keyword()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.set_current_keyword (   self,
  name 
)

Definition at line 1183 of file testrunnerplugin.py.

◆ Start()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.Start (   self)

Signals the start of a test run; initialize progressbar.

Definition at line 1197 of file testrunnerplugin.py.

◆ Stop()

def robotide.contrib.testrunner.testrunnerplugin.ProgressBar.Stop (   self)

Signals the end of a test run.

Definition at line 1207 of file testrunnerplugin.py.

Member Data Documentation

◆ _current_keywords

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._current_keywords
private

Definition at line 1181 of file testrunnerplugin.py.

◆ _default_colour

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._default_colour
private

Definition at line 1168 of file testrunnerplugin.py.

◆ _fail

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._fail
private

Definition at line 1179 of file testrunnerplugin.py.

◆ _foreground_colour

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._foreground_colour
private

Definition at line 1169 of file testrunnerplugin.py.

◆ _gauge

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._gauge
private

Definition at line 1161 of file testrunnerplugin.py.

◆ _label

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._label
private

Definition at line 1162 of file testrunnerplugin.py.

◆ _pass

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._pass
private

Definition at line 1178 of file testrunnerplugin.py.

◆ _sizer

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._sizer
private

Definition at line 1160 of file testrunnerplugin.py.

◆ _skip

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._skip
private

Definition at line 1180 of file testrunnerplugin.py.

◆ _start_time

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._start_time
private

Definition at line 1199 of file testrunnerplugin.py.

◆ _timer

robotide.contrib.testrunner.testrunnerplugin.ProgressBar._timer
private

Definition at line 1173 of file testrunnerplugin.py.

◆ fail_color

robotide.contrib.testrunner.testrunnerplugin.ProgressBar.fail_color

Definition at line 1170 of file testrunnerplugin.py.

◆ pass_color

robotide.contrib.testrunner.testrunnerplugin.ProgressBar.pass_color

Definition at line 1171 of file testrunnerplugin.py.

◆ skip_color

robotide.contrib.testrunner.testrunnerplugin.ProgressBar.skip_color

Definition at line 1172 of file testrunnerplugin.py.


The documentation for this class was generated from the following file: