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) 2012: 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 util.BitmapLibrary import GetBitmap

    28

    29

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

    30

#                        Custom button for Graphic Viewer Class

    31

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

    32

    33

"""

    34

Class that implements a custom button for graphic Viewer

    35

"""

    36

    37

class GraphButton():

    38

    39

    def __init__(self, x, y, bitmap, callback):

    40

        """

    41

        Constructor

    42

        @param x: X coordinate of Button in Graphic Viewer

    43

        @param y: Y coordinate of Button in Graphic Viewer

    44

        @param bitmap: Name of bitmap to use for button

    45

        @param callback: Reference to function to call when button is pressed

    46

        """

    47

        # Save button position

    48

        self.SetPosition(x, y)

    49

        # Set button bitmap

    50

        self.SetBitmap(bitmap)

    51

    52

        # By default button is hide and enabled

    53

        self.Shown = False

    54

        self.Enabled = True

    55

    56

        # Save reference to callback function

    57

        self.Callback = callback

    58

    59

    def __del__(self):

    60

        """

    61

        Destructor

    62

        """

    63

        # Remove reference to callback function

    64

        self.callback = None

    65

    66

    def SetBitmap(self, bitmap):

    67

        """

    68

        Set bitmap to use for button

    69

        @param bitmap: Name of bitmap to use for button

    70

        """

    71

        # Get wx.Bitmap object corresponding to bitmap

    72

        self.Bitmap = GetBitmap(bitmap)

    73

    74

    def GetSize(self):

    75

        """

    76

        Return size of button

    77

        @return: wx.Size object containing button size

    78

        """

    79

        # Button size is size of bitmap

    80

        return self.Bitmap.GetSize()

    81

    82

    def SetPosition(self, x, y):

    83

        """

    84

        Set button position

    85

        @param x: X coordinate of Button in Graphic Viewer

    86

        @param y: Y coordinate of Button in Graphic Viewer

    87

        """

    88

        self.Position = wx.Point(x, y)

    89

    90

    def Show(self, show=True):

    91

        """

    92

        Mark if button to be displayed in Graphic Viewer

    93

        @param show: True if button to be displayed in Graphic Viewer

    94

        (default True)

    95

        """

    96

        self.Shown = show

    97

    98

    def Hide(self):

    99

        """

   100

        Hide button from Graphic Viewer

   101

        """

   102

        self.Show(False)

   103

   104

    def IsShown(self):

   105

        """

   106

        Return if button is displayed in Graphic Viewer

   107

        @return: True if button is displayed in Graphic Viewer

   108

        """

   109

        return self.Shown

   110

   111

    def Enable(self, enable=True):

   112

        """

   113

        Mark if button is active in Graphic Viewer

   114

        @param enable: True if button is active in Graphic Viewer

   115

        (default True)

   116

        """

   117

        self.Enabled = enable

   118

   119

    def Disable(self):

   120

        """

   121

        Deactivate button in Graphic Viewer

   122

        """

   123

        self.Enabled = False

   124

   125

    def IsEnabled(self):

   126

        """

   127

        Return if button is active in Graphic Viewer

   128

        @return: True if button is active in Graphic Viewer

   129

        """

   130

        return self.Enabled

   131

   132

    def HitTest(self, x, y):

   133

        """

   134

        Test if point is inside button

   135

        @param x: X coordinate of point

   136

        @param y: Y coordinate of point

   137

        @return: True if button is active and displayed and point is inside

   138

        button 

   139

        """

   140

        # Return immediately if button is hidden or inactive

   141

        if not (self.IsShown() and self.IsEnabled()):

   142

            return False

   143

   144

        # Test if point is inside button

   145

        w, h = self.Bitmap.GetSize()

   146

        rect = wx.Rect(self.Position.x, self.Position.y, w, h)

   147

        return rect.InsideXY(x, y)

   148

   149

    def ProcessCallback(self):

   150

        """

   151

        Call callback function if defined

   152

        """

   153

        if self.Callback is not None:

   154

            self.Callback()

   155

   156

    def Draw(self, dc):

   157

        """

   158

        Draw button in Graphic Viewer

   159

        @param dc: wx.DC object corresponding to Graphic Viewer device context

   160

        """

   161

        # Only draw button if button is active and displayed

   162

        if self.Shown and self.Enabled:

   163

            dc.DrawBitmap(self.Bitmap, self.Position.x, self.Position.y, True)