clipboard.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 os
 
import wx
 
from ..context import IS_WINDOWS, IS_MAC
 
 
class _ClipboardHandler():
 
    def __init__(self, grid):
        self._grid_grid = grid
        self._clipboard_clipboard = _GridClipboard()
 
    def clipboard_content(self):
        return self._clipboard_clipboard.get_contents()
 
    
    def copy(self):
        # print("DEBUG: Clipboard copy() got called \n")
        if not self._edit_control_shown_edit_control_shown():
            self._add_selected_data_to_clipboard_add_selected_data_to_clipboard()
 
    
    def cut(self):
        self._add_selected_data_to_clipboard_add_selected_data_to_clipboard()
 
    def _add_selected_data_to_clipboard(self):
        self._clipboard_clipboard.set_contents(self._grid_grid.get_selected_content())
 
    
    def paste(self):
        if not self._edit_control_shown_edit_control_shown():
            self._paste_to_grid_paste_to_grid()
 
    def _paste_to_cell_editor(self):
        clipboard = self._clipboard_clipboard.get_contents()
        if isinstance(clipboard, list):
            cells_as_text = ' '.join([' '.join(row) for row in clipboard])
            self._get_edit_control_get_edit_control().WriteText(cells_as_text)
 
    def _paste_to_grid(self):
        clipboard = self._clipboard_clipboard.get_contents()
        if not clipboard:
            return
        cell = self._get_starting_cell_get_starting_cell()
        if not isinstance(clipboard, list):
            self._write_cell_write_cell(cell.row, cell.col, clipboard)
        else:
            row = cell.row
            for datarow in clipboard:
                col = cell.col
                for value in datarow:
                    self._write_cell_write_cell(row, col, value)
                    col += 1
                row += 1
 
    def _get_starting_cell(self):
        return self._grid_grid.selection.topleft
 
    def _write_cell(self, row, col, value):
        self._grid_grid.write_cell(row, col, value, update_history=False)
 
    def _get_edit_control(self):
        return self._grid_grid.get_cell_edit_control()
 
    def _edit_control_shown(self):
        return self._grid_grid.IsCellEditControlShown()
 
 
class _WindowsClipboardHandler(_ClipboardHandler):
 
    def copy(self):
        if self._edit_control_shown_edit_control_shown():
            self._get_edit_control_get_edit_control().Copy()
        else:
            _ClipboardHandler.copy(self)
 
    def cut(self):
        if self._edit_control_shown_edit_control_shown():
            self._get_edit_control_get_edit_control().Cut()
        else:
            _ClipboardHandler.cut(self)
 
    def _paste_to_cell_editor(self):
        self._get_edit_control_get_edit_control().Paste()
 
    def paste(self):
        if self._edit_control_shown_edit_control_shown():
            self._paste_to_cell_editor_paste_to_cell_editor_paste_to_cell_editor()
        else:
            _ClipboardHandler.paste(self)
 
 
# for now mac clipboard handler is the same with windows
ClipboardHandler = _WindowsClipboardHandler if IS_WINDOWS or IS_MAC else _ClipboardHandler
 
 
 
class _GridClipboard():
 
    
    def set_contents(self, data):
        data = self._format_data_format_data(data)
        if not (data and wx.TheClipboard.Open()):
            return
        try:
            tdo = wx.TextDataObject()
            tdo.SetText(data)
            wx.TheClipboard.SetData(tdo)
        finally:
            wx.TheClipboard.Close()
 
    def _format_data(self, data):
        if isinstance(data, list):
            return os.linesep.join('\t'.join(row) for row in data)
        if isinstance(data, str):
            return data
        return None
 
    
    def get_contents(self):
        return self._split_string_from_tabs_and_newlines_split_string_from_tabs_and_newlines(self._get_contents_get_contents())
 
    def _get_contents(self):
        if not wx.TheClipboard.Open():
            return ''
        try:
            tdo = wx.TextDataObject()
            wx.TheClipboard.GetData(tdo)
            return tdo.GetText() or ''
        finally:
            wx.TheClipboard.Close()
 
    def _split_string_from_tabs_and_newlines(self, string):
        return [line.split('\t') for line in string.splitlines()]