1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

    27

from controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD

    28

    29

#-------------------------------------------------------------------------------

    30

#                           Tool Tip Producer class

    31

#-------------------------------------------------------------------------------

    32

    33

"""

    34

Class that implements an element that generate Tool Tip

    35

"""

    36

    37

class ToolTipProducer:

    38

    39

    def __init__(self, parent):

    40

        """

    41

        Constructor

    42

        @param parent: Parent Viewer

    43

        """

    44

        self.Parent = parent

    45

    46

        self.ToolTip = None

    47

        self.ToolTipPos = None

    48

    49

        # Timer for firing Tool tip display

    50

        self.ToolTipTimer = wx.Timer(self.Parent, -1)

    51

        self.Parent.Bind(wx.EVT_TIMER, 

    52

            self.OnToolTipTimer, 

    53

            self.ToolTipTimer)

    54

    55

    def __del__(self):

    56

        """

    57

        Destructor

    58

        """

    59

        self.DestroyToolTip()

    60

    61

    def OnToolTipTimer(self, event):

    62

        """

    63

        Callback for Tool Tip firing timer Event

    64

        @param event: Tool tip text

    65

        """

    66

        # Get Tool Tip text

    67

        value = self.GetToolTipValue()

    68

    69

        if value is not None and self.ToolTipPos is not None:

    70

            # Create Tool Tip

    71

            self.ToolTip = CustomToolTip(self.Parent, value)

    72

            self.ToolTip.SetToolTipPosition(self.ToolTipPos)

    73

            self.ToolTip.Show()

    74

    75

    def GetToolTipValue(self):

    76

        """

    77

        Return tool tip text

    78

        Have to be overridden by inherited classes 

    79

        @return: Tool tip text (None if not overridden) 

    80

        """

    81

        return None

    82

    83

    def DisplayToolTip(self, pos):

    84

        """

    85

        Display Tool tip

    86

        @param pos: Tool tip position

    87

        """

    88

        # Destroy current displayed Tool tip

    89

        self.DestroyToolTip()

    90

    91

        # Save Tool Tip position

    92

        self.ToolTipPos = pos

    93

        # Start Tool tip firing timer

    94

        self.ToolTipTimer.Start(

    95

            int(TOOLTIP_WAIT_PERIOD * 1000), 

    96

            oneShot=True)

    97

    98

    def SetToolTipText(self, text):

    99

        """

   100

        Set current Tool tip text

   101

        @param text: Tool tip Text

   102

        """

   103

        if self.ToolTip is not None:

   104

            self.ToolTip.SetTip(text)

   105

   106

    def DestroyToolTip(self):

   107

        """

   108

        Destroy current displayed Tool Tip

   109

        """

   110

        # Stop Tool tip firing timer

   111

        self.ToolTipTimer.Stop()

   112

        self.ToolTipPos = None

   113

   114

        # Destroy Tool Tip

   115

        if self.ToolTip is not None:

   116

            self.ToolTip.Destroy()

   117

            self.ToolTip = None