tooltips.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
import wx.grid
 
from .popupwindow import HtmlPopupWindow
 
 
class GridToolTips():
 
    def __init__(self, grid):
        self._tooltip_tooltip = HtmlPopupWindow(grid, (250, 80), False, True)
        self._information_popup_information_popup = HtmlPopupWindow(grid, (450, 300))
        self._grid_grid = grid
        self._tooltip_timer_tooltip_timer = wx.Timer(grid.GetGridWindow())
        grid.GetGridWindow().Bind(wx.EVT_WINDOW_DESTROY, self.OnGridDestroyOnGridDestroy)
        grid.GetGridWindow().Bind(wx.EVT_KILL_FOCUS, self.OnGridFocusLostOnGridFocusLost)
        grid.GetGridWindow().Bind(wx.EVT_MOTION, self.OnMouseMotionOnMouseMotion)
        grid.GetGridWindow().Bind(wx.EVT_TIMER, self.OnShowToolTipOnShowToolTip)
        grid.Bind(wx.grid.EVT_GRID_EDITOR_HIDDEN, self.OnGridEditorHiddenOnGridEditorHidden)
 
    def OnGridDestroy(self, event):
        self._tooltip_timer_tooltip_timer.Stop()
        event.Skip()
 
    def OnGridFocusLost(self, event):
        self._tooltip_timer_tooltip_timer.Stop()
        event.Skip()
 
    def OnMouseMotion(self, event):
        self._hide_tooltip_hide_tooltip()
        if event.CmdDown():
            self._tooltip_timer_tooltip_timer.Stop()
            self._grid_grid.show_cell_information()
        else:
            self._information_popup_information_popup.hide()
            self._start_tooltip_timer_start_tooltip_timer()
        event.Skip()
 
    def _start_tooltip_timer(self):
        self._tooltip_timer_tooltip_timer.Start(1000, True)
 
    def OnShowToolTip(self, event):
        self._hide_tooltip_hide_tooltip()
        content = self._grid_grid.get_tooltip_content()
        if content and self._application_has_focus_application_has_focus():
            self._show_tooltip_at_show_tooltip_at(content, self._calculate_tooltip_position_calculate_tooltip_position())
            self._grid_grid.SetFocus()
 
    def _application_has_focus(self):
        window = wx.Window.FindFocus()
        if window is None:
            return False
        rect = window.GetTopLevelParent().GetScreenRect()
        return rect.Contains(wx.GetMousePosition())
 
    def OnGridEditorHidden(self, event):
        cell = event.Row, event.Col
        if cell == self._grid_grid.cell_under_cursor:
            self._start_tooltip_timer_start_tooltip_timer()
 
    def _show_tooltip_at(self, content, position):
        if not self._information_popup_information_popup.IsShown():
            self._tooltip_tooltip.set_content(content)
            self._tooltip_tooltip.show_at(position)
 
    def _calculate_tooltip_position(self):
        x, y = wx.GetMousePosition()
        return x + 16, y + 16   # don't place tooltip under cursor
 
    def _hide_tooltip(self):
        self._tooltip_tooltip.hide()
 
    def hide_information(self):
        self._information_popup_information_popup.hide()
 
    def hide(self):
        self._hide_tooltip_hide_tooltip()
        self.hide_informationhide_information()
 
    def show_info_at(self, info, title, position):
        self._tooltip_tooltip.hide()
        self._information_popup_information_popup.set_content(info, title)
        self._information_popup_information_popup.show_at(position)