__init__.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import wx
from wx import Colour
 
from .editorcreator import EditorCreator
from ..pluginapi import (Plugin, ActionInfoCollection, TreeAwarePluginMixin)
from ..publish import (RideTreeSelection, RideNotebookTabChanging, RideNotebookTabChanged, RideSaving)
from ..publish.messages import RideDataFileRemoved
from ..utils import overrides
from ..widgets import PopupCreator
 
 
_EDIT = """
[Edit]
&Undo | Undo last modification | Ctrlcmd-Z
&Redo | Redo modification | Ctrlcmd-Y
---
Cu&t | Cut | Ctrlcmd-X
&Copy | Copy | Ctrlcmd-C
&Paste | Paste | Ctrlcmd-V
&Insert | Insert | Shift-Ctrl-V
&Delete | Delete  | Del
---
Comment Rows | Comment selected rows | Ctrlcmd-3
CommentCells | Comment cells with # | Ctrlcmd-Shift-3
Uncomment Rows | Uncomment selected rows | Ctrlcmd-4
UncommentCells | Uncomment cells with # | Ctrlcmd-Shift-4
---
Insert Cells | Insert Cells | Ctrlcmd-Shift-I
Delete Cells | Delete Cells | Ctrlcmd-Shift-D
Insert Rows | Insert Rows | Ctrlcmd-I
Delete Rows | Delete Rows | Ctrlcmd-D
[Tools]
Content Assistance (Ctrl-Space or Ctrl-Alt-Space) | Show possible keyword and variable completions | | | POSITION-70
"""
 
 
 
class EditorPlugin(Plugin, TreeAwarePluginMixin):
    def __init__(self, application):
        Plugin.__init__(self, application)
        self._tab_tab = None
        self._grid_popup_creator_grid_popup_creator = PopupCreator()
        self._creator_creator = EditorCreator(self.register_editor)
        self._editor_editor = None
 
    def enable(self):
        self._creator_creator.register_editors()
        self._show_editor_show_editor()
        self.register_actions(
            ActionInfoCollection(_EDIT, self._tab_tab, self._tab_tab))
        self.subscribe(self.OnTreeItemSelectedOnTreeItemSelected, RideTreeSelection)
        self.subscribe(self.OnTabChangedOnTabChanged, RideNotebookTabChanged)
        self.subscribe(self.OnTabChangingOnTabChanging, RideNotebookTabChanging)
        self.subscribe(self.OnSaveToModelOnSaveToModel, RideSaving)
        self.subscribe(self.OnFileDeletedOnFileDeleted, RideDataFileRemoved)
        self.add_self_as_tree_aware_plugin()
 
    def disable(self):
        self.remove_self_from_tree_aware_plugins()
        self.unsubscribe_all()
        self.delete_tab(self._tab_tab)
        wx.CallLater(500, self.unregister_actions())
        self._tab_tab = None
        self._editor_editor = None
 
    def is_focused(self):
        return self.tab_is_visible(self._tab_tab)
 
    def highlight_cell(self, obj, row, column):
        self.showshow()
        self._editor_editor.highlight_cell(obj, row, column)
 
    def highlight(self, text):
        self.showshow()
        self._editor_editor.highlight(text)
 
    def show(self):
        self.show_tab(self._tab_tab)
 
    
    def register_context_menu_hook_to_grid(self, hook):
        self._grid_popup_creator_grid_popup_creator.add_hook(hook)
 
    def unregister_context_menu_hook_to_grid(self, hook):
        self._grid_popup_creator_grid_popup_creator.remove_hook(hook)
 
    def _show_editor(self):
        if not self._tab_tab:
            self._tab_tab = _EditorTab(self)
            self.add_tab(self._tab_tab, 'Edit', allow_closing=False)
        if self.is_focusedis_focused():
            self._editor_editor = self._create_editor_create_editor()
            self._tab_tab.show_editor(self._editor_editor)
 
    def _create_editor(self):
        return self._creator_creator.editor_for(self, self._tab_tab, self.tree)
 
    def OnTreeItemSelected(self, message):
        self._show_editor_show_editor()
        if not self.is_focusedis_focused() and \
           not self.is_focus_on_tree_aware_plugin() and \
           (not message or not message.silent):
            self._editor_editor = self._create_editor_create_editor()
            self._tab_tab.show_editor(self._editor_editor)
            self.showshow()
        if self._editor_editor:
            self._editor_editor.tree_item_selected(message.item)
 
    @overrides(Plugin)
    def get_selected_datafile(self):
        if self._editor_editor and self._editor_editor.controller:
            return self._editor_editor.controller.datafile
        return Plugin.get_selected_datafile(self)
 
    def OnOpenEditor(self, event):
        self._show_editor_show_editor()
 
    def OnTabChanged(self, message):
        self._show_editor_show_editor()
 
    def OnTabChanging(self, message):
        if 'Edit' in message.oldtab:
            self._tab_tab.save()
 
    def OnSaveToModel(self, message):
        if self._tab_tab:
            self._tab_tab.save()
 
    def OnFileDeleted(self, message):
        self._create_editor_create_editor()
 
 
class _EditorTab(wx.Panel):
 
    def __init__(self, plugin):
        wx.Panel.__init__(self, plugin.notebook, style=wx.SUNKEN_BORDER)
        self.pluginplugin = plugin
        self.sizersizer = wx.BoxSizer(wx.VERTICAL)
        self.SetSizer(self.sizersizer)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        self.Refresh(True)
        self.editoreditor = None
 
    def show_editor(self, editor):
        if editor is None:
            return
        if editor is self.editoreditor:
            self.Show(True)
            return
        self.sizersizer.Clear()
        self.editoreditor = editor
        self.sizersizer.Add(self.editoreditor, 1, wx.ALL | wx.EXPAND)
        self.Layout()
        self.Show(True)
 
    def hide_editor(self):
        self.Show(False)
 
    def OnSave(self, event):
        self.pluginplugin.save_selected_datafile()
 
    def OnUndo(self, event):
        self.editoreditor.undo()
 
    def OnRedo(self, event):
        self.editoreditor.redo()
 
    def OnCut(self, event):
        self.editoreditor.cut()
 
    def OnCopy(self, event):
        self.editoreditor.copy()
 
    def OnPaste(self, event):
        self.editoreditor.paste()
 
    def OnInsert(self, event):
        self.editoreditor.insert()
 
    def OnInsertCells(self, event):
        self.editoreditor.insert_cells()
 
    def OnDeleteCells(self, event):
        # print("DEBUG init delete cells call")
        self.editoreditor.delete_cells()
 
    def OnInsertRows(self, event):
        self.editoreditor.insert_rows()
 
    def OnDeleteRows(self, event):
        wx.CallAfter(self.editoreditor.delete_rows)
 
    def OnDelete(self, event):
        self.editoreditor.delete()
 
    def OnCommentRows(self, event):
        self.editoreditor.comment_rows()
 
    def OnUncommentRows(self, event):
        self.editoreditor.uncomment_rows()
 
    def OnCommentCells(self, event):
        self.editoreditor.comment_cells()
 
    def OnUncommentCells(self, event):
        self.editoreditor.uncomment_cells()
 
    def OnContentAssistance(self, event):
        self.editoreditor.show_content_assist()
 
    def save(self, message=None):
        if self.editoreditor:
            self.editoreditor.save()
 
    def OnKey(self, *args):
        pass