Robot Framework Integrated Development Environment (RIDE)
robotide.editor.EditorPlugin Class Reference

The default editor plugin. More...

Inheritance diagram for robotide.editor.EditorPlugin:

Public Member Functions

def __init__ (self, application)
 
def disable (self)
 
def enable (self)
 
def get_selected_datafile (self)
 
def highlight (self, text)
 
def highlight_cell (self, obj, row, column)
 
def is_focused (self)
 
def OnFileDeleted (self, message)
 
def OnOpenEditor (self, event)
 
def OnSaveToModel (self, message)
 
def OnTabChanged (self, message)
 
def OnTabChanging (self, message)
 
def OnTreeItemSelected (self, message)
 
def register_context_menu_hook_to_grid (self, hook)
 Used to register own items to grid's right click context menu. More...
 
def show (self)
 
def unregister_context_menu_hook_to_grid (self, hook)
 

Private Member Functions

def _create_editor (self)
 
def _show_editor (self)
 

Private Attributes

 _creator
 
 _editor
 
 _grid_popup_creator
 
 _tab
 

Detailed Description

The default editor plugin.

This plugin implements editors for the various items of Robot Framework
test data.

Definition at line 59 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.editor.EditorPlugin.__init__ (   self,
  application 
)

Definition at line 60 of file __init__.py.

Member Function Documentation

◆ _create_editor()

def robotide.editor.EditorPlugin._create_editor (   self)
private

Definition at line 122 of file __init__.py.

◆ _show_editor()

def robotide.editor.EditorPlugin._show_editor (   self)
private

Definition at line 114 of file __init__.py.

◆ disable()

def robotide.editor.EditorPlugin.disable (   self)

Definition at line 79 of file __init__.py.

◆ enable()

def robotide.editor.EditorPlugin.enable (   self)

Definition at line 67 of file __init__.py.

◆ get_selected_datafile()

def robotide.editor.EditorPlugin.get_selected_datafile (   self)

Definition at line 137 of file __init__.py.

◆ highlight()

def robotide.editor.EditorPlugin.highlight (   self,
  text 
)

Definition at line 94 of file __init__.py.

◆ highlight_cell()

def robotide.editor.EditorPlugin.highlight_cell (   self,
  obj,
  row,
  column 
)

Definition at line 90 of file __init__.py.

◆ is_focused()

def robotide.editor.EditorPlugin.is_focused (   self)

Definition at line 87 of file __init__.py.

◆ OnFileDeleted()

def robotide.editor.EditorPlugin.OnFileDeleted (   self,
  message 
)

Definition at line 156 of file __init__.py.

◆ OnOpenEditor()

def robotide.editor.EditorPlugin.OnOpenEditor (   self,
  event 
)

Definition at line 142 of file __init__.py.

◆ OnSaveToModel()

def robotide.editor.EditorPlugin.OnSaveToModel (   self,
  message 
)

Definition at line 152 of file __init__.py.

◆ OnTabChanged()

def robotide.editor.EditorPlugin.OnTabChanged (   self,
  message 
)

Definition at line 145 of file __init__.py.

◆ OnTabChanging()

def robotide.editor.EditorPlugin.OnTabChanging (   self,
  message 
)

Definition at line 148 of file __init__.py.

◆ OnTreeItemSelected()

def robotide.editor.EditorPlugin.OnTreeItemSelected (   self,
  message 
)

Definition at line 125 of file __init__.py.

◆ register_context_menu_hook_to_grid()

def robotide.editor.EditorPlugin.register_context_menu_hook_to_grid (   self,
  hook 
)

Used to register own items to grid's right click context menu.

   hook is called with current selection (list of list containing
   values) and it is expected to return list of PopupMenuItem.
   If user selects one of the returned PopupMenuItem, related function
   is called with one argument, the wx event.

Definition at line 108 of file __init__.py.

◆ show()

def robotide.editor.EditorPlugin.show (   self)

Definition at line 98 of file __init__.py.

◆ unregister_context_menu_hook_to_grid()

def robotide.editor.EditorPlugin.unregister_context_menu_hook_to_grid (   self,
  hook 
)

Definition at line 111 of file __init__.py.

Member Data Documentation

◆ _creator

robotide.editor.EditorPlugin._creator
private

Definition at line 64 of file __init__.py.

◆ _editor

robotide.editor.EditorPlugin._editor
private

Definition at line 65 of file __init__.py.

◆ _grid_popup_creator

robotide.editor.EditorPlugin._grid_popup_creator
private

Definition at line 63 of file __init__.py.

◆ _tab

robotide.editor.EditorPlugin._tab
private

Definition at line 62 of file __init__.py.


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