Robot Framework Integrated Development Environment (RIDE)
robotide.ui.treeplugin.TreePlugin Class Reference

Provides a tree view for Test Suites. More...

Inheritance diagram for robotide.ui.treeplugin.TreePlugin:
robotide.pluginapi.plugin.Plugin

Public Member Functions

def __init__ (self, application)
 
def close_tree (self)
 
def disable (self)
 Called by RIDE when the plugin is disabled. More...
 
def enable (self)
 self.register_action(ActionInfo('View','View Test Suites Explorer', self.OnShowTree, shortcut='F12', doc='Show Test Suites tree panel', position=1)) More...
 
def is_focused (self)
 
def OnShowTree (self, event)
 
def OnTabChanged (self, event)
 
def OnTreeSelection (self, message)
 
def populate (self, model)
 
def register_frame (self, parent=None)
 
def set_editor (self, editor)
 
- 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 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...
 

Public Attributes

 pane_id
 
 settings
 
- Public Attributes inherited from robotide.pluginapi.plugin.Plugin
 doc
 
 initially_enabled
 
 metadata
 
 name
 

Static Public Attributes

dictionary defaults
 

Properties

 datafile = property(lambda self: self.get_selected_datafile())
 
- Properties inherited from robotide.pluginapi.plugin.Plugin
 datafile
 
 filemgr
 
 frame
 
 global_settings
 
 menubar
 
 model
 
 notebook
 
 toolbar
 
 tree
 

Private Member Functions

def _update_tree (self, event=None)
 

Private Attributes

 _mgr
 
 _model
 
 _pane
 
 _parent
 
 _tree
 

Detailed Description

Provides a tree view for Test Suites.

Definition at line 66 of file treeplugin.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.ui.treeplugin.TreePlugin.__init__ (   self,
  application 
)

Definition at line 72 of file treeplugin.py.

Member Function Documentation

◆ _update_tree()

def robotide.ui.treeplugin.TreePlugin._update_tree (   self,
  event = None 
)
private

Definition at line 217 of file treeplugin.py.

◆ close_tree()

def robotide.ui.treeplugin.TreePlugin.close_tree (   self)

Definition at line 137 of file treeplugin.py.

◆ disable()

def robotide.ui.treeplugin.TreePlugin.disable (   self)

Called by RIDE when the plugin is disabled.

    Undo whatever was done in the `enable` method.

Reimplemented from robotide.pluginapi.plugin.Plugin.

Definition at line 144 of file treeplugin.py.

◆ enable()

def robotide.ui.treeplugin.TreePlugin.enable (   self)

self.register_action(ActionInfo('View','View Test Suites Explorer', self.OnShowTree, shortcut='F12', doc='Show Test Suites tree panel', position=1))

Reimplemented from robotide.pluginapi.plugin.Plugin.

Definition at line 123 of file treeplugin.py.

◆ is_focused()

def robotide.ui.treeplugin.TreePlugin.is_focused (   self)

Definition at line 150 of file treeplugin.py.

◆ OnShowTree()

def robotide.ui.treeplugin.TreePlugin.OnShowTree (   self,
  event 
)

Definition at line 162 of file treeplugin.py.

◆ OnTabChanged()

def robotide.ui.treeplugin.TreePlugin.OnTabChanged (   self,
  event 
)

Definition at line 212 of file treeplugin.py.

◆ OnTreeSelection()

def robotide.ui.treeplugin.TreePlugin.OnTreeSelection (   self,
  message 
)

Definition at line 208 of file treeplugin.py.

◆ populate()

def robotide.ui.treeplugin.TreePlugin.populate (   self,
  model 
)

Definition at line 153 of file treeplugin.py.

◆ register_frame()

def robotide.ui.treeplugin.TreePlugin.register_frame (   self,
  parent = None 
)

Definition at line 99 of file treeplugin.py.

◆ set_editor()

def robotide.ui.treeplugin.TreePlugin.set_editor (   self,
  editor 
)

Definition at line 159 of file treeplugin.py.

Member Data Documentation

◆ _mgr

robotide.ui.treeplugin.TreePlugin._mgr
private

Definition at line 83 of file treeplugin.py.

◆ _model

robotide.ui.treeplugin.TreePlugin._model
private

Definition at line 89 of file treeplugin.py.

◆ _pane

robotide.ui.treeplugin.TreePlugin._pane
private

Definition at line 95 of file treeplugin.py.

◆ _parent

robotide.ui.treeplugin.TreePlugin._parent
private

Definition at line 75 of file treeplugin.py.

◆ _tree

robotide.ui.treeplugin.TreePlugin._tree
private

Definition at line 76 of file treeplugin.py.

◆ defaults

dictionary robotide.ui.treeplugin.TreePlugin.defaults
static
Initial value:
= {"opened": True,
"docked": True
}

Definition at line 68 of file treeplugin.py.

◆ pane_id

robotide.ui.treeplugin.TreePlugin.pane_id

Definition at line 88 of file treeplugin.py.

◆ settings

robotide.ui.treeplugin.TreePlugin.settings

Definition at line 74 of file treeplugin.py.

Property Documentation

◆ datafile

robotide.ui.treeplugin.TreePlugin.datafile = property(lambda self: self.get_selected_datafile())
static

Definition at line 67 of file treeplugin.py.


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