Robot Framework Integrated Development Environment (RIDE)
robotide.run.runanything.RunAnything Class Reference

A plugin for executing commands on the system. More...

Inheritance diagram for robotide.run.runanything.RunAnything:
robotide.pluginapi.plugin.Plugin

Public Member Functions

def __init__ (self, app)
 
def enable (self)
 This method is called by RIDE when the plugin is enabled. More...
 
def OnManageConfigurations (self, event)
 
- Public Member Functions inherited from robotide.pluginapi.plugin.Plugin
def __getattr__ (self, name)
 Provides convenient attribute access to saved settings. More...
 
def __init__ (self, application, name=None, doc=None, metadata=None, default_settings=None, initially_enabled=True)
 Initialize the plugin with the provided data. More...
 
def add_tab (self, tab, title, allow_closing=True)
 Adds the tab with the title to the tabbed notebook and shows it. More...
 
def all_testcases (self)
 Returns all test cases from all suites in one, unsorted list. More...
 
def allow_tab_closing (self, tab)
 Allows closing a tab that has been created using allow_closing=False. More...
 
def config_panel (self, parent)
 Called by RIDE to get the plugin configuration panel. More...
 
def content_assist_values (self, value='')
 Returns content assist values for currently selected item. More...
 
def delete_tab (self, tab)
 Deletes the tab added using add_tab. More...
 
def disable (self)
 Called by RIDE when the plugin is disabled. More...
 
def disallow_tab_closing (self, tab)
 Disallows closing a tab by use. More...
 
def get_editor (self, item_class)
 Return the current editor class for the given model item class. More...
 
def get_editors (self, item_class)
 Return all registered editors for the given model item class. More...
 
def get_keyword (self, name)
 Returns the keyword object with the given name or None. More...
 
def get_keyword_details (self, name)
 Returns details (documentation, source) of keyword with name name. More...
 
def get_plugins (self)
 Returns list containing plugin wrapper for every loaded plugin. More...
 
def get_selected_datafile (self)
 Returns the data file that is currently selected in the tree. More...
 
def get_selected_item (self)
 Returns the item that is currently selected in the tree. More...
 
def get_user_keyword (self, name)
 Returns user keyword instance whose name is name or None. More...
 
def highlight (self, data, text)
 Highlight a specific text of a given data's edito. More...
 
def highlight_cell (self, tcuk, obj=None, row=-1, column=-1)
 Highlight a specific row/column of a test case or user keyword. More...
 
def is_library_keyword (self, name)
 Returns whether name is a keyword imported by current datafile. More...
 
def is_unsaved_changes (self)
 Returns True if there is any unsaved changes, otherwise False. More...
 
def is_user_keyword (self, name)
 Returns whether name is a user keyword of current datafile. More...
 
def new_suite_can_be_opened (self)
 Checks are there modified files and asks user what to do if there are. More...
 
def open_suite (self, path)
 Opens a test suite specified by the path. More...
 
def publish (self, topic, data)
 Publishes a message with given topic and client data. More...
 
def register_action (self, action_info)
 Registers a menu entry and optionally a shortcut and a toolbar icon. More...
 
def register_actions (self, action_infos)
 Registers multiple menu entries and shortcuts/icons. More...
 
def register_content_assist_hook (self, hook)
 Allows plugin to insert values in content assist dialog. More...
 
def register_editor (self, item_class, editor_class, activate=True)
 Register editor_class as an editor class for model items of type item_class More...
 
def register_search_action (self, description, handler, icon, default=False)
 
def register_shortcut (self, shortcut, callback)
 
def save_all_unsaved_changes (self)
 Saves all the data files that are modified. More...
 
def save_selected_datafile (self)
 Saves the data file that is currently selected in the tree. More...
 
def save_setting (self, name, value, override=True, delay=0)
 Saves the specified setting into the RIDE configuration file. More...
 
def select_user_keyword_node (self, uk)
 Selects node containing the given uk in the tree. More...
 
def set_active_editor (self, item_class, editor_class)
 Activates the specified editor to be used with the specified model item. More...
 
def show_tab (self, tab)
 Makes the tab added using add_tab visible. More...
 
def subscribe (self, listener, *topics)
 Start to listen to messages with the given topics. More...
 
def tab_is_visible (self, tab)
 Returns is the tab added using add_tab visible or not. More...
 
def unregister_actions (self)
 Unregisters all actions registered by this plugin. More...
 
def unregister_editor (self, item_class, editor_class)
 Unregisters editor_class as an editor class for model items of type item_class More...
 
def unsubscribe (self, listener, *topics)
 Stops listening to messages with the given topics. More...
 
def unsubscribe_all (self)
 Stops to listen to all messages this plugin has subscribed to. More...
 

Private Member Functions

def _add_config_to_menu (self, config, index)
 
def _create_menu (self, configs)
 

Private Attributes

 _configs
 

Additional Inherited Members

- Public Attributes inherited from robotide.pluginapi.plugin.Plugin
 doc
 
 initially_enabled
 
 metadata
 
 name
 
- Properties inherited from robotide.pluginapi.plugin.Plugin
 datafile
 
 filemgr
 
 frame
 
 global_settings
 
 menubar
 
 model
 
 notebook
 
 toolbar
 
 tree
 

Detailed Description

A plugin for executing commands on the system.

This plugin enables creation of persistent run configurations and
execution of those. Output of the executed command is displayed in a
separate tab.

Definition at line 30 of file runanything.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.run.runanything.RunAnything.__init__ (   self,
  app 
)

Definition at line 32 of file runanything.py.

Member Function Documentation

◆ _add_config_to_menu()

def robotide.run.runanything.RunAnything._add_config_to_menu (   self,
  config,
  index 
)
private

Definition at line 56 of file runanything.py.

◆ _create_menu()

def robotide.run.runanything.RunAnything._create_menu (   self,
  configs 
)
private

Definition at line 48 of file runanything.py.

◆ enable()

def robotide.run.runanything.RunAnything.enable (   self)

This method is called by RIDE when the plugin is enabled.

    Possible integration to UI should be done in this method and removed
    when the `disable` method is called.

Reimplemented from robotide.pluginapi.plugin.Plugin.

Definition at line 36 of file runanything.py.

◆ OnManageConfigurations()

def robotide.run.runanything.RunAnything.OnManageConfigurations (   self,
  event 
)

Definition at line 39 of file runanything.py.

Member Data Documentation

◆ _configs

robotide.run.runanything.RunAnything._configs
private

Definition at line 34 of file runanything.py.


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