Robot Framework Integrated Development Environment (RIDE)
robotide.controller.settingcontrollers.DocumentationController Class Reference
Inheritance diagram for robotide.controller.settingcontrollers.DocumentationController:
robotide.controller.settingcontrollers._SettingController robotide.controller.basecontroller.ControllerWithParent robotide.controller.basecontroller._BaseController

Public Member Functions

def contains_keyword (self, name)
 
- Public Member Functions inherited from robotide.controller.settingcontrollers._SettingController
def __init__ (self, parent_controller, data)
 
def as_list (self)
 
def clear (self)
 
def contains_variable (self, name)
 
def notify_value_changed (self)
 
def set_comment (self, comment)
 
def set_from (self, other)
 
def set_value (self, value)
 
- Public Member Functions inherited from robotide.controller.basecontroller.ControllerWithParent
def is_modifiable (self)
 
def mark_dirty (self)
 
def set_parent (self, new_parent)
 
- Public Member Functions inherited from robotide.controller.basecontroller._BaseController
def execute (self, command)
 
def is_excluded (self)
 

Properties

 editable_value = property(_get_editable_value, _set_editable_value)
 
 value = property
 
 visible_value = property
 
- Properties inherited from robotide.controller.settingcontrollers._SettingController
 _value = property
 
 comment = property
 
 display_value = property
 
 is_set = property
 
 keyword_name = property
 
 value = property
 
- Properties inherited from robotide.controller.basecontroller.ControllerWithParent
 datafile = property
 
 datafile_controller = property
 
 datafiles = property
 
 dirty = property
 
 parent = property
 
- Properties inherited from robotide.controller.basecontroller._BaseController
 display_name = property
 

Private Member Functions

def _escape_newlines_and_leading_hash (self, item)
 
def _get_editable_value (self)
 
def _init (self, doc)
 
def _newline_replacer (self, match)
 
def _replacer (self, char, match)
 
def _set_editable_value (self, value)
 
def _unescape_newlines_and_whitespaces (self, item)
 
def _whitespace_replacer (self, match)
 
def value (self)
 
def visible_value (self)
 

Private Attributes

 _doc
 

Static Private Attributes

tuple _regexps
 

Additional Inherited Members

- Public Attributes inherited from robotide.controller.settingcontrollers._SettingController
 label
 

Detailed Description

Definition at line 130 of file settingcontrollers.py.

Member Function Documentation

◆ _escape_newlines_and_leading_hash()

def robotide.controller.settingcontrollers.DocumentationController._escape_newlines_and_leading_hash (   self,
  item 
)
private

Definition at line 186 of file settingcontrollers.py.

◆ _get_editable_value()

def robotide.controller.settingcontrollers.DocumentationController._get_editable_value (   self)
private

Definition at line 152 of file settingcontrollers.py.

◆ _init()

def robotide.controller.settingcontrollers.DocumentationController._init (   self,
  doc 
)
private

Definition at line 139 of file settingcontrollers.py.

◆ _newline_replacer()

def robotide.controller.settingcontrollers.DocumentationController._newline_replacer (   self,
  match 
)
private

Definition at line 177 of file settingcontrollers.py.

◆ _replacer()

def robotide.controller.settingcontrollers.DocumentationController._replacer (   self,
  char,
  match 
)
private

Definition at line 180 of file settingcontrollers.py.

◆ _set_editable_value()

def robotide.controller.settingcontrollers.DocumentationController._set_editable_value (   self,
  value 
)
private

Definition at line 155 of file settingcontrollers.py.

◆ _unescape_newlines_and_whitespaces()

def robotide.controller.settingcontrollers.DocumentationController._unescape_newlines_and_whitespaces (   self,
  item 
)
private

Definition at line 166 of file settingcontrollers.py.

◆ _whitespace_replacer()

def robotide.controller.settingcontrollers.DocumentationController._whitespace_replacer (   self,
  match 
)
private

Definition at line 174 of file settingcontrollers.py.

◆ contains_keyword()

def robotide.controller.settingcontrollers.DocumentationController.contains_keyword (   self,
  name 
)

◆ value()

def robotide.controller.settingcontrollers.DocumentationController.value (   self)
private

◆ visible_value()

def robotide.controller.settingcontrollers.DocumentationController.visible_value (   self)
private

Definition at line 163 of file settingcontrollers.py.

Member Data Documentation

◆ _doc

robotide.controller.settingcontrollers.DocumentationController._doc
private

Definition at line 140 of file settingcontrollers.py.

◆ _regexps

robotide.controller.settingcontrollers.DocumentationController._regexps
staticprivate

Definition at line 134 of file settingcontrollers.py.

Property Documentation

◆ editable_value

robotide.controller.settingcontrollers.DocumentationController.editable_value = property(_get_editable_value, _set_editable_value)
static

Definition at line 158 of file settingcontrollers.py.

◆ value

robotide.controller.settingcontrollers.DocumentationController.value = property
static

Definition at line 143 of file settingcontrollers.py.

◆ visible_value

robotide.controller.settingcontrollers.DocumentationController.visible_value = property
static

Definition at line 161 of file settingcontrollers.py.


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