File: progress_dialog.py

package info (click to toggle)
enthought-traits-ui 2.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 15,204 kB
  • ctags: 9,623
  • sloc: python: 45,547; sh: 32; makefile: 19
file content (241 lines) | stat: -rw-r--r-- 7,258 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
# 
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license.  The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
# 
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" A simple progress bar intended to run in the UI thread """

import wx

# Enthought library imports
from enthought.traits.api import Instance, Enum, Str, Int, Bool

# Local imports
from widget import Widget
from window import Window
from dialog import Dialog

class ProgressBar(Widget):
    """ A simple progress bar dialog intended to run in the UI thread """
    
    parent = Instance(wx.Frame)
    direction = Enum('horizontal', 'horizontal', 'vertical')
    
    def __init__(self, parent, minimum=0, maximum=100, direction='horizontal',
                 size=(150, -1)):
        """
        Constructs a progress bar which can be put into a panel, or optionaly,
        its own window
        
        """
        self._max = max        
        self.parent = parent
        
        style = wx.GA_HORIZONTAL
        if direction == "vertical":
            style = wx.GA_VERTICAL
        
        print wx.DefaultSize
        print wx.DefaultPosition
        self.control = wx.Gauge(parent, -1, maximum, style=style, size=size)
        

    def update(self, value):
        """ 
        Updates the progress bar to the desired value.
        
        """
        
        self.control.SetValue(value)
        self.control.Update()        
                
    def _create_parent(self):
        parent = wx.Frame(None, -1, "progress")
        parent.SetExtraStyle(parent.GetExtraStyle() | wx.WS_EX_TRANSIENT)        
        
        return parent            

    def _show(self):
        # Show the parent
        self.parent.Show()
        
        # Show the toolkit-specific control in the parent
        self.control.Show()            

class ProgressDialog(Window):
    """ A simple progress dialog window which allows itself to be updated """
    
    progress_bar = Instance(ProgressBar)
    title = Str
    message = Str
    min = Int
    max = Int
    margin = Int(5)
    can_cancel = Bool(False)

    dialog_size = Instance(wx.Size)

    # Label for the 'cancel' button
    cancel_button_label = Str('Cancel')
    
    def open(self):
        super(ProgressDialog, self).open()
        wx.Yield()

    
    def update(self, value):
        """ 
        updates the progress bar to the desired value. If the value is >= 
        the maximum and the progress bar is not contained in another panel
        the parent window will be closed
        
        """
        
        if self.progress_bar is not None:
            self.progress_bar.update(value)
            
        if value >= self.max:
            self.close()


    def _create_buttons(self, dialog, parent_sizer):
        """ Creates the buttons. """

        sizer = wx.BoxSizer(wx.HORIZONTAL)
        self._cancel = None
        
        if self.can_cancel == True:    
    
            # 'Cancel' button.
            self._cancel = cancel = wx.Button(dialog, wx.ID_CANCEL,
                                              self.cancel_button_label)
            wx.EVT_BUTTON(dialog, wx.ID_CANCEL, self._on_cancel)
            sizer.Add(cancel, 0, wx.LEFT, 10)
            
            button_size = cancel.GetSize()
            self.dialog_size.x = max(self.dialog_size.x, button_size.x + 2*self.margin)
            self.dialog_size.y += button_size.y + 2*self.margin
    
            parent_sizer.Add(sizer, 0, wx.ALIGN_RIGHT | wx.ALL, 5)
        return
    
    def _create_gauge(self, dialog, parent_sizer):
        self.progress_bar = ProgressBar(dialog, self.min, self.max)
        parent_sizer.Add(self.progress_bar.control, 0, wx.CENTER | wx.ALL, 5)

        progress_bar_size = self.progress_bar.control.GetSize()
        self.dialog_size.x = max(self.dialog_size.x, progress_bar_size.x + 2*self.margin)
        self.dialog_size.y += progress_bar_size.y + 2*self.margin

        return
        
    def _create_label(self, dialog, parent_sizer):
        msg_control = wx.StaticText(dialog, -1, self.message)
        parent_sizer.Add(msg_control, 0, wx.LEFT | wx.TOP, 5)

        msg_control_size = msg_control.GetSize()
        self.dialog_size.x = max(self.dialog_size.x, msg_control_size.x + 2*self.margin)
        self.dialog_size.y += msg_control_size.y + 2*self.margin

        return
        
            
    def _create_contents(self, parent):
        """ Creates the window contents.

        This method is intended to be overridden if necessary.  By default we
        just create an empty panel.

        """
        dialog = parent
        
        sizer = wx.BoxSizer(wx.VERTICAL)
        dialog.SetSizer(sizer)
        dialog.SetAutoLayout(True)
        dialog.SetBackgroundColour(wx.NullColor)
        
        self.dialog_size = wx.Size()
        
        # The 'guts' of the dialog.
        self._create_label(dialog, sizer)
        self._create_gauge(dialog, sizer)
        self._create_buttons(dialog, sizer)

        dialog.SetClientSize(self.dialog_size)


#        if self.size != (-1,-1):
#            dialog.SetSize(self.size)
#
#        else:
#            sizer.Fit(dialog)

        dialog.CentreOnParent()
        
        return dialog
            
if __name__ == "__main__":
    #
    # simple example of its use
    #
    import time
    from enthought.pyface.api import GUI, ApplicationWindow
    from enthought.pyface.action.api import Action, MenuManager, MenuBarManager

    def task_func(t):
        progress = ProgressDialog(title="progress", message="counting to %d"%t, max=t)
        progress.open()
        
        for i in range(0,t+1):
            time.sleep(1)
            print i
            progress.update(i)
            
        progress.update(4)

    def _main():
        task_func(4)
    
    class MainWindow(ApplicationWindow):
        """ The main application window. """

        ######################################################################
        # 'object' interface.
        ######################################################################

        def __init__(self, **traits):
            """ Creates a new application window. """

            # Base class constructor.
            super(MainWindow, self).__init__(**traits)

            # Add a menu bar.
            self.menu_bar_manager = MenuBarManager(
                MenuManager(
                    Action(name='E&xit', on_perform=self.close),
                    Action(name='DoIt', on_perform=_main),
                    name = '&File',
                )
            )

            return


    gui = GUI(redirect=False)

    # Create and open the main window.
    window = MainWindow()
    window.open()

    wx.CallAfter(_main)

    # Start the GUI event loop!
    gui.event_loop()