Added ref to Misc/NEWS file; added hint to run regen script on Linux.
[python/dscho.git] / Mac / Lib / EasyDialogs.py
blob3dfe9f3d62a91c1f4561fee2f65375e5446211cc
1 """Easy to use dialogs.
3 Message(msg) -- display a message and an OK button.
4 AskString(prompt, default) -- ask for a string, display OK and Cancel buttons.
5 AskYesNoCancel(question, default) -- display a question and Yes, No and Cancel buttons.
6 bar = Progress(label, maxvalue) -- Display a progress bar
7 bar.set(value) -- Set value
9 More documentation in each function.
10 This module uses DLOG resources 256, 257 and 258.
11 Based upon STDWIN dialogs with the same names and functions.
12 """
14 from Dlg import GetNewDialog, SetDialogItemText, GetDialogItemText, ModalDialog
15 import Qd
16 import addpack
17 addpack.addpack('Tools')
18 addpack.addpack('bgen')
19 addpack.addpack('qd')
20 import QuickDraw
23 def Message(msg):
24 """Display a MESSAGE string.
26 Return when the user clicks the OK button or presses Return.
28 The MESSAGE string can be at most 255 characters long.
29 """
31 id = 256
32 d = GetNewDialog(id, -1)
33 if not d:
34 print "Can't get DLOG resource with id =", id
35 return
36 tp, h, rect = d.GetDialogItem(2)
37 SetDialogItemText(h, msg)
38 d.SetDialogDefaultItem(1)
39 while 1:
40 n = ModalDialog(None)
41 if n == 1:
42 return
45 def AskString(prompt, default = ""):
46 """Display a PROMPT string and a text entry field with a DEFAULT string.
48 Return the contents of the text entry field when the user clicks the
49 OK button or presses Return.
50 Return None when the user clicks the Cancel button.
52 If omitted, DEFAULT is empty.
54 The PROMPT and DEFAULT strings, as well as the return value,
55 can be at most 255 characters long.
56 """
58 id = 257
59 d = GetNewDialog(id, -1)
60 if not d:
61 print "Can't get DLOG resource with id =", id
62 return
63 tp, h, rect = d.GetDialogItem(3)
64 SetDialogItemText(h, prompt)
65 tp, h, rect = d.GetDialogItem(4)
66 SetDialogItemText(h, default)
67 # d.SetDialogItem(4, 0, 255)
68 d.SetDialogDefaultItem(1)
69 d.SetDialogCancelItem(2)
70 while 1:
71 n = ModalDialog(None)
72 if n == 1:
73 tp, h, rect = d.GetDialogItem(4)
74 return GetDialogItemText(h)
75 if n == 2: return None
78 def AskYesNoCancel(question, default = 0):
79 ## """Display a QUESTION string which can be answered with Yes or No.
80 ##
81 ## Return 1 when the user clicks the Yes button.
82 ## Return 0 when the user clicks the No button.
83 ## Return -1 when the user clicks the Cancel button.
84 ##
85 ## When the user presses Return, the DEFAULT value is returned.
86 ## If omitted, this is 0 (No).
87 ##
88 ## The QUESTION strign ca be at most 255 characters.
89 ## """
91 id = 258
92 d = GetNewDialog(id, -1)
93 if not d:
94 print "Can't get DLOG resource with id =", id
95 return
96 # Button assignments:
97 # 1 = default (invisible)
98 # 2 = Yes
99 # 3 = No
100 # 4 = Cancel
101 # The question string is item 5
102 tp, h, rect = d.GetDialogItem(5)
103 SetDialogItemText(h, question)
104 d.SetDialogCancelItem(4)
105 if default in (2, 3, 4):
106 d.SetDialogDefaultItem(default)
107 while 1:
108 n = ModalDialog(None)
109 if n == 1: return default
110 if n == 2: return 1
111 if n == 3: return 0
112 if n == 4: return -1
114 class ProgressBar:
115 def __init__(self, label="Working...", maxval=100):
116 self.label = label
117 self.maxval = maxval
118 self.curval = -1
119 self.d = GetNewDialog(259, -1)
120 tp, text_h, rect = self.d.GetDialogItem(2)
121 SetDialogItemText(text_h, "Progress...")
122 self._update(0)
124 def _update(self, value):
125 tp, h, bar_rect = self.d.GetDialogItem(3)
126 Qd.SetPort(self.d)
128 Qd.FrameRect(bar_rect) # Draw outline
130 inner_rect = Qd.InsetRect(bar_rect, 1, 1)
131 Qd.ForeColor(QuickDraw.whiteColor)
132 Qd.BackColor(QuickDraw.whiteColor)
133 Qd.PaintRect(inner_rect) # Clear internal
135 l, t, r, b = inner_rect
136 r = int(l + (r-l)*value/self.maxval)
137 inner_rect = l, t, r, b
138 Qd.ForeColor(QuickDraw.blackColor)
139 Qd.BackColor(QuickDraw.blackColor)
140 Qd.PaintRect(inner_rect) # Draw bar
142 # Restore settings
143 Qd.ForeColor(QuickDraw.blackColor)
144 Qd.BackColor(QuickDraw.whiteColor)
146 # Test for cancel button
147 if ModalDialog(self._filterfunc) == 1:
148 raise KeyboardInterrupt
150 def _filterfunc(self, d, e, *more):
151 return 2 # XXXX For now, this disables the cancel button
153 def set(self, value):
154 if value < 0: value = 0
155 if value > self.maxval: value = self.maxval
156 self._update(value)
160 def test():
161 Message("Testing EasyDialogs.")
162 ok = AskYesNoCancel("Do you want to proceed?")
163 if ok > 0:
164 s = AskString("Enter your first name")
165 Message("Thank you,\015%s" % `s`)
166 bar = ProgressBar("Counting...", 100)
167 for i in range(100):
168 bar.set(i)
169 del bar
172 if __name__ == '__main__':
173 test()