1

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

     2

# ENHANCEDSTATUSBAR wxPython IMPLEMENTATION

     3

# Python Code By:

     4

#

     5

# Andrea Gavana, @ 31 May 2005

     6

# Nitro, @ 21 September 2005

     7

# Latest Revision: 21 September 2005, 19.57.20 GMT+2

     8

# Latest Revision before Latest Revision: 21 September 2005, 18.29.35 GMT+2

     9

# Latest Revision before Latest Revision before Latest Revision: 31 May 2005, 23.17 CET

    10

#

    11

#

    12

# TODO List/Caveats

    13

#

    14

# 1. Some Requests/Features To Add?

    15

#

    16

#

    17

# For All Kind Of Problems, Requests Of Enhancements And Bug Reports, Please

    18

# Write To Me At:

    19

#

    20

#

    21

# andrea.gavana@agip.it

    22

# andrea_gavan@tin.it

    23

#

    24

# Or, Obviously, To The wxPython Mailing List!!!

    25

#

    26

#

    27

# licensed under wxWidgets License (GPL compatible)

    28

# End Of Comments

    29

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

    30

    31

""" Description:

    32

    33

EnhancedStatusBar Is A Slight Modification (Actually A Subclassing) Of wx.StatusBar.

    34

It Allows You To Add Almost Any Widget You Like To The wx.StatusBar Of Your Main

    35

Frame Application And Also To Layout Them Properly.

    36

    37

    38

What It Can Do:

    39

    40

1) Almost All The Functionalities Of wx.StatusBar Are Still Present;

    41

2) You Can Add Different Kind Of Widgets Into Every Field Of The EnhancedStatusBar;

    42

3) The AddWidget() Methods Accepts 2 Layout Inputs:

    43

   - horizontalalignment: This Specify The Horizontal Alignment For Your Widget,

    44

     And Can Be ESB_EXACT_FIT, ESB_ALIGN_CENTER_HORIZONTAL, ESB_ALIGN_LEFT And

    45

     ESB_ALIGN_RIGHT;

    46

   - varticalalignment: This Specify The Vertical Alignment For Your Widget,

    47

     And Can Be ESB_EXACT_FIT, ESB_ALIGN_CENTER_VERTICAL, ESB_ALIGN_BOTTOM And

    48

     ESB_ALIGN_LEFT;

    49

    50

EnhancedStatusBar Is Freeware And Distributed Under The wxPython License.

    51

    52

Latest Revision: 21 September 2005, 19.57.20 GMT+2

    53

Latest Revision before Latest Revision: 21 September 2005, 18.29.35 GMT+2

    54

Latest Revision before Latest Revision before Latest Revision: 31 May 2005, 23.17 CET

    55

    56

"""

    57

    58

from __future__ import absolute_import

    59

import wx

    60

    61

# Horizontal Alignment Constants

    62

ESB_ALIGN_CENTER_VERTICAL = 1

    63

ESB_ALIGN_TOP = 2

    64

ESB_ALIGN_BOTTOM = 3

    65

    66

# Vertical Alignment Constants

    67

ESB_ALIGN_CENTER_HORIZONTAL = 11

    68

ESB_ALIGN_LEFT = 12

    69

ESB_ALIGN_RIGHT = 13

    70

    71

# Exact Fit (Either Horizontal Or Vertical Or Both) Constant

    72

ESB_EXACT_FIT = 20

    73

    74

    75

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

    76

# Class EnhancedStatusBar

    77

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

    78

# This Is The Main Class Implementation. See The Demo For Details

    79

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

    80

class EnhancedStatusBarItem(object):

    81

    def __init__(self, widget, pos, horizontalalignment=ESB_ALIGN_CENTER_HORIZONTAL, verticalalignment=ESB_ALIGN_CENTER_VERTICAL):

    82

        self.__dict__.update(locals())

    83

    84

    85

class EnhancedStatusBar(wx.StatusBar):

    86

    87

    def __init__(self, parent, id=wx.ID_ANY, style=wx.ST_SIZEGRIP,

    88

                 name="EnhancedStatusBar"):

    89

        """Default Class Constructor.

    90

    91

        EnhancedStatusBar.__init__(self, parent, id=wx.ID_ANY,

    92

                                   style=wx.ST_SIZEGRIP,

    93

                                   name="EnhancedStatusBar")

    94

        """

    95

    96

        wx.StatusBar.__init__(self, parent, id, style, name)

    97

    98

        self._items = {}

    99

        self._curPos = 0

   100

        self._parent = parent

   101

   102

        wx.EVT_SIZE(self, self.OnSize)

   103

        wx.CallAfter(self.OnSize, None)

   104

   105

    def OnSize(self, event):

   106

        """Handles The wx.EVT_SIZE Events For The StatusBar.

   107

   108

        Actually, All The Calculations Linked To HorizontalAlignment And

   109

        VerticalAlignment Are Done In This Function."""

   110

   111

        for pos, item in self._items.items():

   112

            widget, horizontalalignment, verticalalignment = item.widget, item.horizontalalignment, item.verticalalignment

   113

   114

            rect = self.GetFieldRect(pos)

   115

            widgetsize = widget.GetSize()

   116

   117

            rect = self.GetFieldRect(pos)

   118

   119

            if horizontalalignment == ESB_EXACT_FIT:

   120

   121

                if verticalalignment == ESB_EXACT_FIT:

   122

                    # 1 September 2015 Fix fit align

   123

                    widget.SetSize((rect.width-4, rect.height-4))

   124

                    widget.SetPosition((rect.x+2, rect.y+2))

   125

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   126

                    if widgetsize[1] < rect.width - 1:

   127

                        diffs = (rect.height - widgetsize[1])/2

   128

                        widget.SetSize((rect.width-2, widgetsize[1]))

   129

                        widget.SetPosition((rect.x-1, rect.y+diffs))

   130

                    else:

   131

                        widget.SetSize((rect.width-2, widgetsize[1]))

   132

                        widget.SetPosition((rect.x-1, rect.y-1))

   133

                elif verticalalignment == ESB_ALIGN_TOP:

   134

                    widget.SetSize((rect.width-2, widgetsize[1]))

   135

                    widget.SetPosition((rect.x-1, rect.y))

   136

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   137

                    widget.SetSize((rect.width-2, widgetsize[1]))

   138

                    widget.SetPosition((rect.x-1, rect.height-widgetsize[1]))

   139

   140

            elif horizontalalignment == ESB_ALIGN_LEFT:

   141

   142

                xpos = rect.x - 1

   143

                if verticalalignment == ESB_EXACT_FIT:

   144

                    widget.SetSize((widgetsize[0], rect.height-2))

   145

                    widget.SetPosition((xpos, rect.y-1))

   146

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   147

                    if widgetsize[1] < rect.height - 1:

   148

                        diffs = (rect.height - widgetsize[1])/2

   149

                        widget.SetPosition((xpos, rect.y+diffs))

   150

                    else:

   151

                        widget.SetSize((widgetsize[0], rect.height-2))

   152

                        widget.SetPosition((xpos, rect.y-1))

   153

                elif verticalalignment == ESB_ALIGN_TOP:

   154

                    widget.SetPosition((xpos, rect.y))

   155

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   156

                    widget.SetPosition((xpos, rect.height-widgetsize[1]))

   157

   158

            elif horizontalalignment == ESB_ALIGN_RIGHT:

   159

   160

                xpos = rect.x + rect.width - widgetsize[0] - 1

   161

                if verticalalignment == ESB_EXACT_FIT:

   162

                    widget.SetSize((widgetsize[0], rect.height-2))

   163

                    widget.SetPosition((xpos, rect.y-1))

   164

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   165

                    if widgetsize[1] < rect.height - 1:

   166

                        diffs = (rect.height - widgetsize[1])/2

   167

                        widget.SetPosition((xpos, rect.y+diffs))

   168

                    else:

   169

                        widget.SetSize((widgetsize[0], rect.height-2))

   170

                        widget.SetPosition((xpos, rect.y-1))

   171

                elif verticalalignment == ESB_ALIGN_TOP:

   172

                    widget.SetPosition((xpos, rect.y))

   173

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   174

                    widget.SetPosition((xpos, rect.height-widgetsize[1]))

   175

   176

            elif horizontalalignment == ESB_ALIGN_CENTER_HORIZONTAL:

   177

   178

                xpos = rect.x + (rect.width - widgetsize[0])/2 - 1

   179

                if verticalalignment == ESB_EXACT_FIT:

   180

                    widget.SetSize((widgetsize[0], rect.height))

   181

                    widget.SetPosition((xpos, rect.y))

   182

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   183

                    if widgetsize[1] < rect.height - 1:

   184

                        diffs = (rect.height - widgetsize[1])/2

   185

                        widget.SetPosition((xpos, rect.y+diffs))

   186

                    else:

   187

                        widget.SetSize((widgetsize[0], rect.height-1))

   188

                        widget.SetPosition((xpos, rect.y+1))

   189

                elif verticalalignment == ESB_ALIGN_TOP:

   190

                    widget.SetPosition((xpos, rect.y))

   191

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   192

                    widget.SetPosition((xpos, rect.height-widgetsize[1]))

   193

   194

        if event is not None:

   195

            event.Skip()

   196

   197

    def AddWidget(self, widget, horizontalalignment=ESB_ALIGN_CENTER_HORIZONTAL,

   198

                  verticalalignment=ESB_ALIGN_CENTER_VERTICAL, pos=-1):

   199

        """Add A Widget To The EnhancedStatusBar.

   200

   201

        Parameters:

   202

   203

        - horizontalalignment: This Can Be One Of:

   204

          a) ESB_EXACT_FIT: The Widget Will Fit Horizontally The StatusBar Field Width;

   205

          b) ESB_ALIGN_CENTER_HORIZONTAL: The Widget Will Be Centered Horizontally In

   206

             The StatusBar Field;

   207

          c) ESB_ALIGN_LEFT: The Widget Will Be Left Aligned In The StatusBar Field;

   208

          d) ESB_ALIGN_RIGHT: The Widget Will Be Right Aligned In The StatusBar Field;

   209

   210

        - verticalalignment:

   211

          a) ESB_EXACT_FIT: The Widget Will Fit Vertically The StatusBar Field Height;

   212

          b) ESB_ALIGN_CENTER_VERTICAL: The Widget Will Be Centered Vertically In

   213

             The StatusBar Field;

   214

          c) ESB_ALIGN_BOTTOM: The Widget Will Be Bottom Aligned In The StatusBar Field;

   215

          d) ESB_ALIGN_TOP: The Widget Will Be TOP Aligned In The StatusBar Field;

   216

   217

        """

   218

   219

        if pos == -1:

   220

            pos = self._curPos

   221

            self._curPos += 1

   222

   223

        if self.GetFieldsCount() <= pos:

   224

            raise "\nERROR: EnhancedStatusBar has a max of %d items, you tried to set item #%d" % (self.GetFieldsCount(), pos)

   225

   226

        if horizontalalignment not in [ESB_ALIGN_CENTER_HORIZONTAL, ESB_EXACT_FIT,

   227

                                       ESB_ALIGN_LEFT, ESB_ALIGN_RIGHT]:

   228

            raise '\nERROR: Parameter "horizontalalignment" Should Be One Of '\

   229

                  '"ESB_ALIGN_CENTER_HORIZONTAL", "ESB_ALIGN_LEFT", "ESB_ALIGN_RIGHT"' \

   230

                  '"ESB_EXACT_FIT"'

   231

   232

        if verticalalignment not in [ESB_ALIGN_CENTER_VERTICAL, ESB_EXACT_FIT,

   233

                                     ESB_ALIGN_TOP, ESB_ALIGN_BOTTOM]:

   234

            raise '\nERROR: Parameter "verticalalignment" Should Be One Of '\

   235

                  '"ESB_ALIGN_CENTER_VERTICAL", "ESB_ALIGN_TOP", "ESB_ALIGN_BOTTOM"' \

   236

                  '"ESB_EXACT_FIT"'

   237

   238

        try:

   239

            self.RemoveChild(self._items[pos].widget)

   240

            self._items[pos].widget.Destroy()

   241

        except KeyError:

   242

            pass

   243

   244

        self._items[pos] = EnhancedStatusBarItem(widget, pos, horizontalalignment, verticalalignment)

   245

   246

        wx.CallAfter(self.OnSize, None)