Robot Framework Integrated Development Environment (RIDE)
robotide.controller.filecontrollers.ResourceFileController Class Reference
Inheritance diagram for robotide.controller.filecontrollers.ResourceFileController:
robotide.controller.filecontrollers._FileSystemElement robotide.controller.filecontrollers._DataController robotide.controller.basecontroller._BaseController robotide.controller.basecontroller.WithUndoRedoStacks robotide.controller.basecontroller.WithNamespace

Public Member Functions

def __init__ (self, data, project=None, parent=None, resource_file_controller_factory=None)
 
def add_known_import (self, _import)
 
def get_where_used (self)
 
def is_modifiable (self)
 
def is_used (self)
 
def notify_opened (self)
 
def reload (self)
 
def remove (self)
 
def remove_child (self, controller)
 
def remove_known_import (self, _import)
 
def remove_static_imports_to_this (self)
 
def set_basename (self, basename)
 
def set_basename_and_modify_imports (self, basename)
 
def set_format (self, format)
 
def validate_name (self, name)
 
- Public Member Functions inherited from robotide.controller.filecontrollers._FileSystemElement
def __init__ (self, filename, directory)
 
def exists (self)
 
def has_been_modified_on_disk (self)
 
def has_been_removed_from_disk (self)
 
def is_readonly (self)
 
def refresh_stat (self)
 
def relative_path_to (self, other)
 
- Public Member Functions inherited from robotide.controller.filecontrollers._DataController
def __init__ (self, data, project=None, parent=None)
 
def add_test_or_keyword (self, item)
 
def create_keyword (self, name, argstr='')
 
def get_format (self)
 
def get_keyword_names (self)
 
def get_local_variables (self)
 
def has_format (self)
 
def is_directory_suite (self)
 
def is_inside_top_suite (self, res)
 
def is_library_keyword (self, value)
 
def is_same_format (self, format)
 
def is_user_keyword (self, value)
 
def iter_datafiles (self)
 
def keyword_info (self, keyword_name)
 
def mark_dirty (self)
 
def notify_settings_changed (self)
 
def notify_steps_changed (self)
 
def open_filemanager (self, path=None)
 
def remove_folder_from_filesystem (self, path=None)
 
def remove_from_filesystem (self, path=None)
 
def remove_readonly (self, path=None)
 
def resource_import_modified (self, path)
 
def restore_keyword_order (self, index_difference)
 
def restore_test_order (self, index_difference)
 
def restore_variable_order (self, index_difference)
 
def save (self)
 
def save_with_new_format (self, format)
 
def save_with_new_format_recursive (self, format)
 
def set_datafile (self, datafile)
 
def sort_keywords (self)
 
def sort_tests (self)
 
def sort_variables (self)
 
def unmark_dirty (self)
 
def validate_keyword_name (self, name)
 
- Public Member Functions inherited from robotide.controller.basecontroller._BaseController
def execute (self, command)
 
def is_excluded (self)
 
- Public Member Functions inherited from robotide.controller.basecontroller.WithUndoRedoStacks
def clear_redo (self)
 
def clear_undo (self)
 
def is_redo_empty (self)
 
def is_undo_empty (self)
 
def pop_from_redo (self)
 
def pop_from_undo (self)
 
def push_to_redo (self, command)
 
def push_to_undo (self, command)
 
- Public Member Functions inherited from robotide.controller.basecontroller.WithNamespace
def clear_namespace_update_listeners (self)
 
def get_all_cached_library_names (self)
 
def get_all_keywords_from (self, *datafiles)
 
def get_namespace (self)
 
def is_library_import_ok (self, imp)
 
def is_library_keyword (self, datafile, value)
 
def is_user_keyword (self, datafile, value)
 
def is_variables_import_ok (self, imp)
 
def keyword_info (self, datafile, keyword_name)
 
def register_for_namespace_updates (self, listener)
 
def unregister_namespace_updates (self, listener)
 
def update_namespace (self)
 

Properties

 display_name = property
 
- Properties inherited from robotide.controller.filecontrollers._FileSystemElement
 basename = property
 
 source = property
 Deprecated, use filename or directory instead. More...
 
- Properties inherited from robotide.controller.filecontrollers._DataController
 _setting_table = property
 
 datafile = property
 
 datafile_controller = property
 
 datafiles = property
 
 force_tags = property
 
 imports = property
 
 keywords = property
 
 metadata = property
 
 name = property
 
 settings = property
 
 tests = property
 
 variables = property
 
- Properties inherited from robotide.controller.basecontroller._BaseController
 display_name = property
 
- Properties inherited from robotide.controller.basecontroller.WithUndoRedoStacks
 _redo = property
 
 _undo = property
 

Private Member Functions

def _all_imports (self)
 
def _find_parent_for (self, project, source)
 
def _modify_file_name (self, modification, notification)
 
def _resolve_known_imports (self)
 
def _settings (self)
 
def _to_os_style (self, path)
 
def _unresolve_all_if_none_existing (self)
 
def display_name (self)
 

Private Attributes

 _known_imports
 
 _resource_file_controller_factory
 

Additional Inherited Members

- Public Attributes inherited from robotide.controller.filecontrollers._FileSystemElement
 directory
 
 filename
 
- Public Attributes inherited from robotide.controller.filecontrollers._DataController
 children
 
 data
 
 dirty
 
 filename
 
 parent
 

Detailed Description

Definition at line 860 of file filecontrollers.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.controller.filecontrollers.ResourceFileController.__init__ (   self,
  data,
  project = None,
  parent = None,
  resource_file_controller_factory = None 
)

Definition at line 862 of file filecontrollers.py.

Member Function Documentation

◆ _all_imports()

def robotide.controller.filecontrollers.ResourceFileController._all_imports (   self)
private

Definition at line 986 of file filecontrollers.py.

◆ _find_parent_for()

def robotide.controller.filecontrollers.ResourceFileController._find_parent_for (   self,
  project,
  source 
)
private

Definition at line 880 of file filecontrollers.py.

◆ _modify_file_name()

def robotide.controller.filecontrollers.ResourceFileController._modify_file_name (   self,
  modification,
  notification 
)
private

Definition at line 925 of file filecontrollers.py.

◆ _resolve_known_imports()

def robotide.controller.filecontrollers.ResourceFileController._resolve_known_imports (   self)
private

Definition at line 980 of file filecontrollers.py.

◆ _settings()

def robotide.controller.filecontrollers.ResourceFileController._settings (   self)
private

Reimplemented from robotide.controller.filecontrollers._DataController.

Definition at line 933 of file filecontrollers.py.

◆ _to_os_style()

def robotide.controller.filecontrollers.ResourceFileController._to_os_style (   self,
  path 
)
private

Definition at line 889 of file filecontrollers.py.

◆ _unresolve_all_if_none_existing()

def robotide.controller.filecontrollers.ResourceFileController._unresolve_all_if_none_existing (   self)
private

Definition at line 875 of file filecontrollers.py.

◆ add_known_import()

def robotide.controller.filecontrollers.ResourceFileController.add_known_import (   self,
  _import 
)

Definition at line 953 of file filecontrollers.py.

◆ display_name()

def robotide.controller.filecontrollers.ResourceFileController.display_name (   self)
private

Reimplemented from robotide.controller.basecontroller._BaseController.

Definition at line 895 of file filecontrollers.py.

◆ get_where_used()

def robotide.controller.filecontrollers.ResourceFileController.get_where_used (   self)

Definition at line 970 of file filecontrollers.py.

◆ is_modifiable()

def robotide.controller.filecontrollers.ResourceFileController.is_modifiable (   self)

Reimplemented from robotide.controller.basecontroller._BaseController.

Definition at line 899 of file filecontrollers.py.

◆ is_used()

def robotide.controller.filecontrollers.ResourceFileController.is_used (   self)

Definition at line 961 of file filecontrollers.py.

◆ notify_opened()

def robotide.controller.filecontrollers.ResourceFileController.notify_opened (   self)

Definition at line 956 of file filecontrollers.py.

◆ reload()

def robotide.controller.filecontrollers.ResourceFileController.reload (   self)

Definition at line 942 of file filecontrollers.py.

◆ remove()

def robotide.controller.filecontrollers.ResourceFileController.remove (   self)

Definition at line 946 of file filecontrollers.py.

◆ remove_child()

def robotide.controller.filecontrollers.ResourceFileController.remove_child (   self,
  controller 
)

Definition at line 991 of file filecontrollers.py.

◆ remove_known_import()

def robotide.controller.filecontrollers.ResourceFileController.remove_known_import (   self,
  _import 
)

Definition at line 950 of file filecontrollers.py.

◆ remove_static_imports_to_this()

def robotide.controller.filecontrollers.ResourceFileController.remove_static_imports_to_this (   self)

Definition at line 916 of file filecontrollers.py.

◆ set_basename()

def robotide.controller.filecontrollers.ResourceFileController.set_basename (   self,
  basename 
)

Reimplemented from robotide.controller.filecontrollers._DataController.

Definition at line 906 of file filecontrollers.py.

◆ set_basename_and_modify_imports()

def robotide.controller.filecontrollers.ResourceFileController.set_basename_and_modify_imports (   self,
  basename 
)

Definition at line 910 of file filecontrollers.py.

◆ set_format()

def robotide.controller.filecontrollers.ResourceFileController.set_format (   self,
  format 
)

Reimplemented from robotide.controller.filecontrollers._DataController.

Definition at line 902 of file filecontrollers.py.

◆ validate_name()

def robotide.controller.filecontrollers.ResourceFileController.validate_name (   self,
  name 
)

Definition at line 936 of file filecontrollers.py.

Member Data Documentation

◆ _known_imports

robotide.controller.filecontrollers.ResourceFileController._known_imports
private

Definition at line 867 of file filecontrollers.py.

◆ _resource_file_controller_factory

robotide.controller.filecontrollers.ResourceFileController._resource_file_controller_factory
private

Definition at line 864 of file filecontrollers.py.

Property Documentation

◆ display_name

robotide.controller.filecontrollers.ResourceFileController.display_name = property
static

Definition at line 893 of file filecontrollers.py.


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