1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

    27

import wx

    28

    29

from controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD

    30

    31

    32

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

    33

#                           Tool Tip Producer class

    34

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

    35

    36

    37

class ToolTipProducer(object):

    38

    """

    39

    Class that implements an element that generate Tool Tip

    40

    """

    41

    42

    def __init__(self, parent):

    43

        """

    44

        Constructor

    45

        @param parent: Parent Viewer

    46

        """

    47

        self.Parent = parent

    48

    49

        self.ToolTip = None

    50

        self.ToolTipPos = None

    51

    52

        # Timer for firing Tool tip display

    53

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

    54

        self.Parent.Bind(wx.EVT_TIMER,

    55

                         self.OnToolTipTimer,

    56

                         self.ToolTipTimer)

    57

    58

    def OnToolTipTimer(self, event):

    59

        """

    60

        Callback for Tool Tip firing timer Event

    61

        @param event: Tool tip text

    62

        """

    63

        # Get Tool Tip text

    64

        value = self.GetToolTipValue()

    65

    66

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

    67

            # Create Tool Tip

    68

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

    69

            self.ToolTip.SetToolTipPosition(self.ToolTipPos)

    70

            self.ToolTip.Show()

    71

    72

    def GetToolTipValue(self):

    73

        """

    74

        Return tool tip text

    75

        Have to be overridden by inherited classes

    76

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

    77

        """

    78

        return None

    79

    80

    def DisplayToolTip(self, pos):

    81

        """

    82

        Display Tool tip

    83

        @param pos: Tool tip position

    84

        """

    85

        # Destroy current displayed Tool tip

    86

        self.DestroyToolTip()

    87

    88

        # Save Tool Tip position

    89

        self.ToolTipPos = pos

    90

        # Start Tool tip firing timer

    91

        self.ToolTipTimer.Start(

    92

            int(TOOLTIP_WAIT_PERIOD * 1000),

    93

            oneShot=True)

    94

    95

    def SetToolTipText(self, text):

    96

        """

    97

        Set current Tool tip text

    98

        @param text: Tool tip Text

    99

        """

   100

        if self.ToolTip is not None:

   101

            self.ToolTip.SetTip(text)

   102

   103

    def DestroyToolTip(self):

   104

        """

   105

        Destroy current displayed Tool Tip

   106

        """

   107

        # Stop Tool tip firing timer

   108

        self.ToolTipTimer.Stop()

   109

        self.ToolTipPos = None

   110

   111

        # Destroy Tool Tip

   112

        if self.ToolTip is not None:

   113

            self.ToolTip.Destroy()

   114

            self.ToolTip = None