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

    26

from __future__ import absolute_import

    27

import wx

    28

    29

from util.BitmapLibrary import GetBitmap

    30

    31

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

    32

#                        Custom button for Graphic Viewer Class

    33

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

    34

    35

    36

class GraphButton(object):

    37

    """

    38

    Class that implements a custom button for graphic Viewer

    39

    """

    40

    41

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

    42

        """

    43

        Constructor

    44

        @param x: X coordinate of Button in Graphic Viewer

    45

        @param y: Y coordinate of Button in Graphic Viewer

    46

        @param bitmap: Name of bitmap to use for button

    47

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

    48

        """

    49

        # Save button position

    50

        self.SetPosition(x, y)

    51

        # Set button bitmap

    52

        self.SetBitmap(bitmap)

    53

    54

        # By default button is hide and enabled

    55

        self.Shown = False

    56

        self.Enabled = True

    57

    58

        # Save reference to callback function

    59

        self.Callback = callback

    60

    61

    def __del__(self):

    62

        """

    63

        Destructor

    64

        """

    65

        # Remove reference to callback function

    66

        self.callback = None

    67

    68

    def SetBitmap(self, bitmap):

    69

        """

    70

        Set bitmap to use for button

    71

        @param bitmap: Name of bitmap to use for button

    72

        """

    73

        # Get wx.Bitmap object corresponding to bitmap

    74

        self.Bitmap = GetBitmap(bitmap)

    75

    76

    def GetSize(self):

    77

        """

    78

        Return size of button

    79

        @return: wx.Size object containing button size

    80

        """

    81

        # Button size is size of bitmap

    82

        return self.Bitmap.GetSize()

    83

    84

    def SetPosition(self, x, y):

    85

        """

    86

        Set button position

    87

        @param x: X coordinate of Button in Graphic Viewer

    88

        @param y: Y coordinate of Button in Graphic Viewer

    89

        """

    90

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

    91

    92

    def Show(self, show=True):

    93

        """

    94

        Mark if button to be displayed in Graphic Viewer

    95

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

    96

        (default True)

    97

        """

    98

        self.Shown = show

    99

   100

    def Hide(self):

   101

        """

   102

        Hide button from Graphic Viewer

   103

        """

   104

        self.Show(False)

   105

   106

    def IsShown(self):

   107

        """

   108

        Return if button is displayed in Graphic Viewer

   109

        @return: True if button is displayed in Graphic Viewer

   110

        """

   111

        return self.Shown

   112

   113

    def Enable(self, enable=True):

   114

        """

   115

        Mark if button is active in Graphic Viewer

   116

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

   117

        (default True)

   118

        """

   119

        self.Enabled = enable

   120

   121

    def Disable(self):

   122

        """

   123

        Deactivate button in Graphic Viewer

   124

        """

   125

        self.Enabled = False

   126

   127

    def IsEnabled(self):

   128

        """

   129

        Return if button is active in Graphic Viewer

   130

        @return: True if button is active in Graphic Viewer

   131

        """

   132

        return self.Enabled

   133

   134

    def HitTest(self, x, y):

   135

        """

   136

        Test if point is inside button

   137

        @param x: X coordinate of point

   138

        @param y: Y coordinate of point

   139

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

   140

        button

   141

        """

   142

        # Return immediately if button is hidden or inactive

   143

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

   144

            return False

   145

   146

        # Test if point is inside button

   147

        w, h = self.Bitmap.GetSize()

   148

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

   149

        return rect.InsideXY(x, y)

   150

   151

    def ProcessCallback(self):

   152

        """

   153

        Call callback function if defined

   154

        """

   155

        if self.Callback is not None:

   156

            self.Callback()

   157

   158

    def Draw(self, dc):

   159

        """

   160

        Draw button in Graphic Viewer

   161

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

   162

        """

   163

        # Only draw button if button is active and displayed

   164

        if self.Shown and self.Enabled:

   165

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