Robot Framework Integrated Development Environment (RIDE)
robotide.controller.stepcontrollers.StepController Class Reference
Inheritance diagram for robotide.controller.stepcontrollers.StepController:
robotide.controller.basecontroller._BaseController robotide.controller.stepcontrollers.ForLoopStepController robotide.controller.stepcontrollers.IntendedStepController

Public Member Functions

def __eq__ (self, other)
 
def __init__ (self, parent, step)
 
def __len__ (self)
 
def as_list (self)
 
def change (self, col, new_value, delete=False)
 
def comment (self)
 
def contains_keyword (self, name)
 
def contains_variable (self, name)
 
def contains_variable_assignment (self, name)
 
def decrease_indent (self)
 
def get_cell_info (self, col)
 
def get_keyword_info (self, kw)
 
def get_value (self, col)
 
def has_only_comment (self)
 
def increase_indent (self)
 
def insert_after (self, new_step)
 
def insert_before (self, new_step)
 
def insert_value_before (self, col, new_value)
 
def is_assigning (self, value)
 
def is_library_keyword (self, value)
 
def is_modifiable (self)
 
def is_user_keyword (self, value)
 
def move_down (self)
 
def move_up (self)
 
def notify_value_changed (self)
 
def recalculate_keyword_column (self)
 
def remove (self)
 
def remove_empty_columns_from_beginning (self)
 
def remove_empty_columns_from_end (self, delete=True)
 
def replace_keyword (self, new_name, old_name)
 
def shift_left (self, from_column, delete=False)
 
def shift_right (self, from_column, delete=False)
 
def uncomment (self)
 
- Public Member Functions inherited from robotide.controller.basecontroller._BaseController
def execute (self, command)
 
def is_excluded (self)
 

Static Public Member Functions

def first_non_empty_cell (cells)
 

Public Attributes

 indent
 
 parent
 

Properties

 _keyword_column = property
 
 args = property
 
 assign = property
 
 assignments = property
 
 datafile = property
 
 datafile_controller = property
 
 display_name = property
 
 keyword = property
 
 steps = property
 
 vars = property
 
- Properties inherited from robotide.controller.basecontroller._BaseController
 display_name = property
 

Private Member Functions

def _build_cell_info (self, content, position)
 
def _change_last_empty_to_empty_var (self, args, comment)
 
def _first_non_empty_cell (self)
 
def _get_cell_position (self, column)
 
def _get_comment (self, cells)
 
def _get_content_with_type (self, col, position)
 
def _get_last_none_empty_col_idx (self)
 
def _get_local_namespace (self)
 
def _has_comment_keyword (self)
 
def _has_list_or_dict_var_value_before (self, arg_index)
 
def _index (self)
 
def _init (self, parent, step)
 
def _is_commented (self, col)
 
def _is_end_step (self, cells)
 
def _is_for_loop (self)
 
def _is_intended_step (self, cells)
 
def _is_partial_for_loop_step (self, cells)
 
def _is_unknow_variable (self, value, position)
 
def _keyword_column (self)
 
def _kw_name_match (self, item, expected)
 
def _kw_name_replace (self, old_value, new_match, old_match)
 
def _last_argument_is_varargs (self, args)
 
def _number_of_mandatory_arguments (self, args, args_amount)
 
def _recreate (self, cells, comment=None, delete=False)
 
def _recreate_as_intended_step (self, for_loop_step, cells, comment, index)
 
def _recreate_next_step (self, index)
 
def _steps_are_equal (self, fst, snd)
 
def args (self)
 
def assign (self)
 
def assignments (self)
 
def datafile (self)
 
def datafile_controller (self)
 
def display_name (self)
 
def keyword (self)
 
def steps (self)
 
def vars (self)
 

Private Attributes

 _step
 

Static Private Attributes

 _GIVEN_WHEN_THEN_MATCHER
 

Detailed Description

Definition at line 25 of file stepcontrollers.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.controller.stepcontrollers.StepController.__init__ (   self,
  parent,
  step 
)

Member Function Documentation

◆ __eq__()

def robotide.controller.stepcontrollers.StepController.__eq__ (   self,
  other 
)

Definition at line 83 of file stepcontrollers.py.

◆ __len__()

def robotide.controller.stepcontrollers.StepController.__len__ (   self)

Definition at line 594 of file stepcontrollers.py.

◆ _build_cell_info()

def robotide.controller.stepcontrollers.StepController._build_cell_info (   self,
  content,
  position 
)
private

◆ _change_last_empty_to_empty_var()

def robotide.controller.stepcontrollers.StepController._change_last_empty_to_empty_var (   self,
  args,
  comment 
)
private

Definition at line 71 of file stepcontrollers.py.

◆ _first_non_empty_cell()

def robotide.controller.stepcontrollers.StepController._first_non_empty_cell (   self)
private

Definition at line 359 of file stepcontrollers.py.

◆ _get_cell_position()

def robotide.controller.stepcontrollers.StepController._get_cell_position (   self,
  column 
)
private

◆ _get_comment()

def robotide.controller.stepcontrollers.StepController._get_comment (   self,
  cells 
)
private

◆ _get_content_with_type()

def robotide.controller.stepcontrollers.StepController._get_content_with_type (   self,
  col,
  position 
)
private

◆ _get_last_none_empty_col_idx()

def robotide.controller.stepcontrollers.StepController._get_last_none_empty_col_idx (   self)
private

Definition at line 236 of file stepcontrollers.py.

◆ _get_local_namespace()

def robotide.controller.stepcontrollers.StepController._get_local_namespace (   self)
private

◆ _has_comment_keyword()

def robotide.controller.stepcontrollers.StepController._has_comment_keyword (   self)
private

◆ _has_list_or_dict_var_value_before()

def robotide.controller.stepcontrollers.StepController._has_list_or_dict_var_value_before (   self,
  arg_index 
)
private

Definition at line 180 of file stepcontrollers.py.

◆ _index()

def robotide.controller.stepcontrollers.StepController._index (   self)
private

Definition at line 524 of file stepcontrollers.py.

◆ _init()

def robotide.controller.stepcontrollers.StepController._init (   self,
  parent,
  step 
)
private

Definition at line 38 of file stepcontrollers.py.

◆ _is_commented()

def robotide.controller.stepcontrollers.StepController._is_commented (   self,
  col 
)
private

Definition at line 351 of file stepcontrollers.py.

◆ _is_end_step()

def robotide.controller.stepcontrollers.StepController._is_end_step (   self,
  cells 
)
private

Definition at line 555 of file stepcontrollers.py.

◆ _is_for_loop()

def robotide.controller.stepcontrollers.StepController._is_for_loop (   self)
private

Definition at line 549 of file stepcontrollers.py.

◆ _is_intended_step()

def robotide.controller.stepcontrollers.StepController._is_intended_step (   self,
  cells 
)
private

Definition at line 552 of file stepcontrollers.py.

◆ _is_partial_for_loop_step()

def robotide.controller.stepcontrollers.StepController._is_partial_for_loop_step (   self,
  cells 
)
private

Definition at line 545 of file stepcontrollers.py.

◆ _is_unknow_variable()

def robotide.controller.stepcontrollers.StepController._is_unknow_variable (   self,
  value,
  position 
)
private

Definition at line 216 of file stepcontrollers.py.

◆ _keyword_column()

def robotide.controller.stepcontrollers.StepController._keyword_column (   self)
private

Definition at line 371 of file stepcontrollers.py.

◆ _kw_name_match()

def robotide.controller.stepcontrollers.StepController._kw_name_match (   self,
  item,
  expected 
)
private

Definition at line 268 of file stepcontrollers.py.

◆ _kw_name_replace()

def robotide.controller.stepcontrollers.StepController._kw_name_replace (   self,
  old_value,
  new_match,
  old_match 
)
private

Definition at line 287 of file stepcontrollers.py.

◆ _last_argument_is_varargs()

def robotide.controller.stepcontrollers.StepController._last_argument_is_varargs (   self,
  args 
)
private

Definition at line 177 of file stepcontrollers.py.

◆ _number_of_mandatory_arguments()

def robotide.controller.stepcontrollers.StepController._number_of_mandatory_arguments (   self,
  args,
  args_amount 
)
private

Definition at line 170 of file stepcontrollers.py.

◆ _recreate()

def robotide.controller.stepcontrollers.StepController._recreate (   self,
  cells,
  comment = None,
  delete = False 
)
private

◆ _recreate_as_intended_step()

def robotide.controller.stepcontrollers.StepController._recreate_as_intended_step (   self,
  for_loop_step,
  cells,
  comment,
  index 
)
private

Definition at line 566 of file stepcontrollers.py.

◆ _recreate_next_step()

def robotide.controller.stepcontrollers.StepController._recreate_next_step (   self,
  index 
)
private

Definition at line 571 of file stepcontrollers.py.

◆ _steps_are_equal()

def robotide.controller.stepcontrollers.StepController._steps_are_equal (   self,
  fst,
  snd 
)
private

Definition at line 88 of file stepcontrollers.py.

◆ args()

def robotide.controller.stepcontrollers.StepController.args (   self)
private

Definition at line 318 of file stepcontrollers.py.

◆ as_list()

def robotide.controller.stepcontrollers.StepController.as_list (   self)

Definition at line 252 of file stepcontrollers.py.

◆ assign()

def robotide.controller.stepcontrollers.StepController.assign (   self)
private

Definition at line 312 of file stepcontrollers.py.

◆ assignments()

def robotide.controller.stepcontrollers.StepController.assignments (   self)
private

◆ change()

def robotide.controller.stepcontrollers.StepController.change (   self,
  col,
  new_value,
  delete = False 
)

Definition at line 327 of file stepcontrollers.py.

◆ comment()

def robotide.controller.stepcontrollers.StepController.comment (   self)

◆ contains_keyword()

def robotide.controller.stepcontrollers.StepController.contains_keyword (   self,
  name 
)

◆ contains_variable()

def robotide.controller.stepcontrollers.StepController.contains_variable (   self,
  name 
)

Definition at line 256 of file stepcontrollers.py.

◆ contains_variable_assignment()

def robotide.controller.stepcontrollers.StepController.contains_variable_assignment (   self,
  name 
)

Definition at line 260 of file stepcontrollers.py.

◆ datafile()

def robotide.controller.stepcontrollers.StepController.datafile (   self)
private

Definition at line 300 of file stepcontrollers.py.

◆ datafile_controller()

def robotide.controller.stepcontrollers.StepController.datafile_controller (   self)
private

Definition at line 68 of file stepcontrollers.py.

◆ decrease_indent()

def robotide.controller.stepcontrollers.StepController.decrease_indent (   self)

Definition at line 583 of file stepcontrollers.py.

◆ display_name()

def robotide.controller.stepcontrollers.StepController.display_name (   self)
private

Reimplemented from robotide.controller.basecontroller._BaseController.

Definition at line 62 of file stepcontrollers.py.

◆ first_non_empty_cell()

def robotide.controller.stepcontrollers.StepController.first_non_empty_cell (   cells)
static

Definition at line 431 of file stepcontrollers.py.

◆ get_cell_info()

def robotide.controller.stepcontrollers.StepController.get_cell_info (   self,
  col 
)

◆ get_keyword_info()

def robotide.controller.stepcontrollers.StepController.get_keyword_info (   self,
  kw 
)

Definition at line 78 of file stepcontrollers.py.

◆ get_value()

def robotide.controller.stepcontrollers.StepController.get_value (   self,
  col 
)

Definition at line 97 of file stepcontrollers.py.

◆ has_only_comment()

def robotide.controller.stepcontrollers.StepController.has_only_comment (   self)

Definition at line 527 of file stepcontrollers.py.

◆ increase_indent()

def robotide.controller.stepcontrollers.StepController.increase_indent (   self)

Definition at line 579 of file stepcontrollers.py.

◆ insert_after()

def robotide.controller.stepcontrollers.StepController.insert_after (   self,
  new_step 
)

◆ insert_before()

def robotide.controller.stepcontrollers.StepController.insert_before (   self,
  new_step 
)

Definition at line 437 of file stepcontrollers.py.

◆ insert_value_before()

def robotide.controller.stepcontrollers.StepController.insert_value_before (   self,
  col,
  new_value 
)

Definition at line 338 of file stepcontrollers.py.

◆ is_assigning()

def robotide.controller.stepcontrollers.StepController.is_assigning (   self,
  value 
)

Definition at line 116 of file stepcontrollers.py.

◆ is_library_keyword()

def robotide.controller.stepcontrollers.StepController.is_library_keyword (   self,
  value 
)

Definition at line 249 of file stepcontrollers.py.

◆ is_modifiable()

def robotide.controller.stepcontrollers.StepController.is_modifiable (   self)

Reimplemented from robotide.controller.basecontroller._BaseController.

Definition at line 243 of file stepcontrollers.py.

◆ is_user_keyword()

def robotide.controller.stepcontrollers.StepController.is_user_keyword (   self,
  value 
)

Definition at line 246 of file stepcontrollers.py.

◆ keyword()

def robotide.controller.stepcontrollers.StepController.keyword (   self)
private

Definition at line 306 of file stepcontrollers.py.

◆ move_down()

def robotide.controller.stepcontrollers.StepController.move_down (   self)

◆ move_up()

def robotide.controller.stepcontrollers.StepController.move_up (   self)

◆ notify_value_changed()

def robotide.controller.stepcontrollers.StepController.notify_value_changed (   self)

Definition at line 576 of file stepcontrollers.py.

◆ recalculate_keyword_column()

def robotide.controller.stepcontrollers.StepController.recalculate_keyword_column (   self)

Definition at line 374 of file stepcontrollers.py.

◆ remove()

def robotide.controller.stepcontrollers.StepController.remove (   self)

◆ remove_empty_columns_from_beginning()

def robotide.controller.stepcontrollers.StepController.remove_empty_columns_from_beginning (   self)

Definition at line 500 of file stepcontrollers.py.

◆ remove_empty_columns_from_end()

def robotide.controller.stepcontrollers.StepController.remove_empty_columns_from_end (   self,
  delete = True 
)

◆ replace_keyword()

def robotide.controller.stepcontrollers.StepController.replace_keyword (   self,
  new_name,
  old_name 
)

Definition at line 276 of file stepcontrollers.py.

◆ shift_left()

def robotide.controller.stepcontrollers.StepController.shift_left (   self,
  from_column,
  delete = False 
)

Definition at line 414 of file stepcontrollers.py.

◆ shift_right()

def robotide.controller.stepcontrollers.StepController.shift_right (   self,
  from_column,
  delete = False 
)

Definition at line 404 of file stepcontrollers.py.

◆ steps()

def robotide.controller.stepcontrollers.StepController.steps (   self)
private

◆ uncomment()

def robotide.controller.stepcontrollers.StepController.uncomment (   self)

Definition at line 395 of file stepcontrollers.py.

◆ vars()

def robotide.controller.stepcontrollers.StepController.vars (   self)
private

Definition at line 324 of file stepcontrollers.py.

Member Data Documentation

◆ _GIVEN_WHEN_THEN_MATCHER

robotide.controller.stepcontrollers.StepController._GIVEN_WHEN_THEN_MATCHER
staticprivate

Definition at line 30 of file stepcontrollers.py.

◆ _step

robotide.controller.stepcontrollers.StepController._step
private

Definition at line 40 of file stepcontrollers.py.

◆ indent

robotide.controller.stepcontrollers.StepController.indent

Definition at line 42 of file stepcontrollers.py.

◆ parent

robotide.controller.stepcontrollers.StepController.parent

Definition at line 39 of file stepcontrollers.py.

Property Documentation

◆ _keyword_column

robotide.controller.stepcontrollers.StepController._keyword_column = property
staticprivate

Definition at line 369 of file stepcontrollers.py.

◆ args

robotide.controller.stepcontrollers.StepController.args = property
static

Definition at line 316 of file stepcontrollers.py.

◆ assign

robotide.controller.stepcontrollers.StepController.assign = property
static

Definition at line 310 of file stepcontrollers.py.

◆ assignments

robotide.controller.stepcontrollers.StepController.assignments = property
static

Definition at line 111 of file stepcontrollers.py.

◆ datafile

robotide.controller.stepcontrollers.StepController.datafile = property
static

Definition at line 298 of file stepcontrollers.py.

◆ datafile_controller

robotide.controller.stepcontrollers.StepController.datafile_controller = property
static

Definition at line 66 of file stepcontrollers.py.

◆ display_name

robotide.controller.stepcontrollers.StepController.display_name = property
static

Definition at line 60 of file stepcontrollers.py.

◆ keyword

robotide.controller.stepcontrollers.StepController.keyword = property
static

Definition at line 304 of file stepcontrollers.py.

◆ steps

robotide.controller.stepcontrollers.StepController.steps = property
static

Definition at line 588 of file stepcontrollers.py.

◆ vars

robotide.controller.stepcontrollers.StepController.vars = property
static

Definition at line 322 of file stepcontrollers.py.


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