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

import wx

    26

    27

from controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD

    28

    29

    30

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

    31

#                           Tool Tip Producer class

    32

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

    33

    34

    36

    """

    37

    Class that implements an element that generate Tool Tip

    38

    """

    39

    40

    def __init__(self, parent):

    41

        """

    42

        Constructor

    43

        @param parent: Parent Viewer

    44

        """

    45

        self.Parent = parent

    46

    47

        self.ToolTip = None

    48

        self.ToolTipPos = None

    49

    50

        # Timer for firing Tool tip display

    51

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

    52

        self.Parent.Bind(wx.EVT_TIMER,

    53

                         self.OnToolTipTimer,

    54

                         self.ToolTipTimer)

    55

    56

    def __del__(self):

    57

        """

    58

        Destructor

    59

        """

    60

        self.DestroyToolTip()

    61

    62

    def OnToolTipTimer(self, event):

    63

        """

    64

        Callback for Tool Tip firing timer Event

    65

        @param event: Tool tip text

    66

        """

    67

        # Get Tool Tip text

    68

        value = self.GetToolTipValue()

    69

    70

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

    71

            # Create Tool Tip

    72

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

    73

            self.ToolTip.SetToolTipPosition(self.ToolTipPos)

    74

            self.ToolTip.Show()

    75

    76

    def GetToolTipValue(self):

    77

        """

    78

        Return tool tip text

    79

        Have to be overridden by inherited classes

    80

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

    81

        """

    82

        return None

    83

    84

    def DisplayToolTip(self, pos):

    85

        """

    86

        Display Tool tip

    87

        @param pos: Tool tip position

    88

        """

    89

        # Destroy current displayed Tool tip

    90

        self.DestroyToolTip()

    91

    92

        # Save Tool Tip position

    93

        self.ToolTipPos = pos

    94

        # Start Tool tip firing timer

    95

        self.ToolTipTimer.Start(

    96

            int(TOOLTIP_WAIT_PERIOD * 1000),

    97

            oneShot=True)

    98

    99

    def SetToolTipText(self, text):

   100

        """

   101

        Set current Tool tip text

   102

        @param text: Tool tip Text

   103

        """

   104

        if self.ToolTip is not None:

   105

            self.ToolTip.SetTip(text)

   106

   107

    def DestroyToolTip(self):

   108

        """

   109

        Destroy current displayed Tool Tip

   110

        """

   111

        # Stop Tool tip firing timer

   112

        self.ToolTipTimer.Stop()

   113

        self.ToolTipPos = None

   114

   115

        # Destroy Tool Tip

   116

        if self.ToolTip is not None:

   117

            self.ToolTip.Destroy()

   118

            self.ToolTip = None