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

from __future__ import division

    60

import wx

    61

    62

# Horizontal Alignment Constants

    63

ESB_ALIGN_CENTER_VERTICAL = 1

    64

ESB_ALIGN_TOP = 2

    65

ESB_ALIGN_BOTTOM = 3

    66

    67

# Vertical Alignment Constants

    68

ESB_ALIGN_CENTER_HORIZONTAL = 11

    69

ESB_ALIGN_LEFT = 12

    70

ESB_ALIGN_RIGHT = 13

    71

    72

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

    73

ESB_EXACT_FIT = 20

    74

    75

    76

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

    77

# Class EnhancedStatusBar

    78

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

    79

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

    80

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

    81

class EnhancedStatusBarItem(object):

    82

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

    83

        self.__dict__.update(locals())

    84

    85

    86

class EnhancedStatusBar(wx.StatusBar):

    87

    88

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

    89

                 name="EnhancedStatusBar"):

    90

        """Default Class Constructor.

    91

    92

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

    93

                                   style=wx.ST_SIZEGRIP,

    94

                                   name="EnhancedStatusBar")

    95

        """

    96

    97

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

    98

    99

        self._items = {}

   100

        self._curPos = 0

   101

        self._parent = parent

   102

   103

        wx.EVT_SIZE(self, self.OnSize)

   104

        wx.CallAfter(self.OnSize, None)

   105

   106

    def OnSize(self, event):

   107

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

   108

   109

        Actually, All The Calculations Linked To HorizontalAlignment And

   110

        VerticalAlignment Are Done In This Function."""

   111

   112

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

   113

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

   114

   115

            rect = self.GetFieldRect(pos)

   116

            widgetsize = widget.GetSize()

   117

   118

            rect = self.GetFieldRect(pos)

   119

   120

            if horizontalalignment == ESB_EXACT_FIT:

   121

   122

                if verticalalignment == ESB_EXACT_FIT:

   123

                    # 1 September 2015 Fix fit align

   124

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

   125

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

   126

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   127

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

   128

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

   129

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

   130

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

   131

                    else:

   132

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

   133

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

   134

                elif verticalalignment == ESB_ALIGN_TOP:

   135

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

   136

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

   137

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   138

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

   139

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

   140

   141

            elif horizontalalignment == ESB_ALIGN_LEFT:

   142

   143

                xpos = rect.x - 1

   144

                if verticalalignment == ESB_EXACT_FIT:

   145

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

   146

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

   147

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   148

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

   149

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

   150

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

   151

                    else:

   152

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

   153

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

   154

                elif verticalalignment == ESB_ALIGN_TOP:

   155

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

   156

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   157

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

   158

   159

            elif horizontalalignment == ESB_ALIGN_RIGHT:

   160

   161

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

   162

                if verticalalignment == ESB_EXACT_FIT:

   163

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

   164

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

   165

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   166

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

   167

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

   168

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

   169

                    else:

   170

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

   171

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

   172

                elif verticalalignment == ESB_ALIGN_TOP:

   173

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

   174

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   175

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

   176

   177

            elif horizontalalignment == ESB_ALIGN_CENTER_HORIZONTAL:

   178

   179

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

   180

                if verticalalignment == ESB_EXACT_FIT:

   181

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

   182

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

   183

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   184

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

   185

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

   186

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

   187

                    else:

   188

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

   189

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

   190

                elif verticalalignment == ESB_ALIGN_TOP:

   191

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

   192

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   193

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

   194

   195

        if event is not None:

   196

            event.Skip()

   197

   198

    def AddWidget(self, widget, horizontalalignment=ESB_ALIGN_CENTER_HORIZONTAL,

   199

                  verticalalignment=ESB_ALIGN_CENTER_VERTICAL, pos=-1):

   200

        """Add A Widget To The EnhancedStatusBar.

   201

   202

        Parameters:

   203

   204

        - horizontalalignment: This Can Be One Of:

   205

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

   206

          b) ESB_ALIGN_CENTER_HORIZONTAL: The Widget Will Be Centered Horizontally In

   207

             The StatusBar Field;

   208

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

   209

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

   210

   211

        - verticalalignment:

   212

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

   213

          b) ESB_ALIGN_CENTER_VERTICAL: The Widget Will Be Centered Vertically In

   214

             The StatusBar Field;

   215

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

   216

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

   217

   218

        """

   219

   220

        if pos == -1:

   221

            pos = self._curPos

   222

            self._curPos += 1

   223

   224

        if self.GetFieldsCount() <= pos:

   225

            raise ValueError("\nERROR: EnhancedStatusBar has a max of %d items, you tried to set item #%d" %

   226

                             (self.GetFieldsCount(), pos))

   227

   228

        if horizontalalignment not in [ESB_ALIGN_CENTER_HORIZONTAL, ESB_EXACT_FIT,

   229

                                       ESB_ALIGN_LEFT, ESB_ALIGN_RIGHT]:

   230

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

   231

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

   232

                             '"ESB_EXACT_FIT"')

   233

   234

        if verticalalignment not in [ESB_ALIGN_CENTER_VERTICAL, ESB_EXACT_FIT,

   235

                                     ESB_ALIGN_TOP, ESB_ALIGN_BOTTOM]:

   236

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

   237

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

   238

                             '"ESB_EXACT_FIT"')

   239

   240

        try:

   241

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

   242

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

   243

        except KeyError:

   244

            pass

   245

   246

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

   247

   248

        wx.CallAfter(self.OnSize, None)