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

import wx

    59

    60

# Horizontal Alignment Constants

    61

ESB_ALIGN_CENTER_VERTICAL = 1

    62

ESB_ALIGN_TOP = 2

    63

ESB_ALIGN_BOTTOM = 3

    64

    65

# Vertical Alignment Constants

    66

ESB_ALIGN_CENTER_HORIZONTAL = 11

    67

ESB_ALIGN_LEFT = 12

    68

ESB_ALIGN_RIGHT = 13

    69

    70

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

    71

ESB_EXACT_FIT = 20

    72

    73

    74

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

    75

# Class EnhancedStatusBar

    76

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

    77

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

    78

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

    79

class EnhancedStatusBarItem(object):

    80

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

    81

        self.__dict__.update(locals())

    82

    83

    84

class EnhancedStatusBar(wx.StatusBar):

    85

    86

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

    87

                 name="EnhancedStatusBar"):

    88

        """Default Class Constructor.

    89

    90

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

    91

                                   style=wx.ST_SIZEGRIP,

    92

                                   name="EnhancedStatusBar")

    93

        """

    94

    95

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

    96

    97

        self._items = {}

    98

        self._curPos = 0

    99

        self._parent = parent

   100

   101

        wx.EVT_SIZE(self, self.OnSize)

   102

        wx.CallAfter(self.OnSize, None)

   103

   104

    def OnSize(self, event):

   105

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

   106

   107

        Actually, All The Calculations Linked To HorizontalAlignment And

   108

        VerticalAlignment Are Done In This Function."""

   109

   110

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

   111

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

   112

   113

            rect = self.GetFieldRect(pos)

   114

            widgetsize = widget.GetSize()

   115

   116

            rect = self.GetFieldRect(pos)

   117

   118

            if horizontalalignment == ESB_EXACT_FIT:

   119

   120

                if verticalalignment == ESB_EXACT_FIT:

   121

                    # 1 September 2015 Fix fit align

   122

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

   123

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

   124

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   125

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

   126

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

   127

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

   128

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

   129

                    else:

   130

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

   131

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

   132

                elif verticalalignment == ESB_ALIGN_TOP:

   133

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

   134

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

   135

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   136

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

   137

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

   138

   139

            elif horizontalalignment == ESB_ALIGN_LEFT:

   140

   141

                xpos = rect.x - 1

   142

                if verticalalignment == ESB_EXACT_FIT:

   143

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

   144

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

   145

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   146

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

   147

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

   148

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

   149

                    else:

   150

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

   151

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

   152

                elif verticalalignment == ESB_ALIGN_TOP:

   153

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

   154

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   155

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

   156

   157

            elif horizontalalignment == ESB_ALIGN_RIGHT:

   158

   159

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

   160

                if verticalalignment == ESB_EXACT_FIT:

   161

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

   162

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

   163

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   164

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

   165

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

   166

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

   167

                    else:

   168

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

   169

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

   170

                elif verticalalignment == ESB_ALIGN_TOP:

   171

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

   172

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   173

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

   174

   175

            elif horizontalalignment == ESB_ALIGN_CENTER_HORIZONTAL:

   176

   177

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

   178

                if verticalalignment == ESB_EXACT_FIT:

   179

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

   180

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

   181

                elif verticalalignment == ESB_ALIGN_CENTER_VERTICAL:

   182

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

   183

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

   184

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

   185

                    else:

   186

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

   187

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

   188

                elif verticalalignment == ESB_ALIGN_TOP:

   189

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

   190

                elif verticalalignment == ESB_ALIGN_BOTTOM:

   191

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

   192

   193

        if event is not None:

   194

            event.Skip()

   195

   196

    def AddWidget(self, widget, horizontalalignment=ESB_ALIGN_CENTER_HORIZONTAL,

   197

                  verticalalignment=ESB_ALIGN_CENTER_VERTICAL, pos=-1):

   198

        """Add A Widget To The EnhancedStatusBar.

   199

   200

        Parameters:

   201

   202

        - horizontalalignment: This Can Be One Of:

   203

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

   204

          b) ESB_ALIGN_CENTER_HORIZONTAL: The Widget Will Be Centered Horizontally In

   205

             The StatusBar Field;

   206

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

   207

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

   208

   209

        - verticalalignment:

   210

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

   211

          b) ESB_ALIGN_CENTER_VERTICAL: The Widget Will Be Centered Vertically In

   212

             The StatusBar Field;

   213

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

   214

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

   215

   216

        """

   217

   218

        if pos == -1:

   219

            pos = self._curPos

   220

            self._curPos += 1

   221

   222

        if self.GetFieldsCount() <= pos:

   223

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

   224

   225

        if horizontalalignment not in [ESB_ALIGN_CENTER_HORIZONTAL, ESB_EXACT_FIT,

   226

                                       ESB_ALIGN_LEFT, ESB_ALIGN_RIGHT]:

   227

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

   228

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

   229

                  '"ESB_EXACT_FIT"'

   230

   231

        if verticalalignment not in [ESB_ALIGN_CENTER_VERTICAL, ESB_EXACT_FIT,

   232

                                     ESB_ALIGN_TOP, ESB_ALIGN_BOTTOM]:

   233

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

   234

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

   235

                  '"ESB_EXACT_FIT"'

   236

   237

        try:

   238

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

   239

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

   240

        except KeyError:

   241

            pass

   242

   243

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

   244

   245

        wx.CallAfter(self.OnSize, None)