blob: 4df6ecee69f1d2d56c1f09c84a62d3b98600ae69 [file] [log] [blame]
Kurt B. Kaisere7a161e2003-01-10 20:13:57 +00001"""IDLE Configuration Dialog: support user customization of IDLE by GUI
2
3Customize font faces, sizes, and colorization attributes. Set indentation
4defaults. Customize keybindings. Colorization and keybindings can be
5saved as user defined sets. Select startup options including shell/editor
6and default window size. Define additional help sources.
7
8Note that tab width in IDLE is currently fixed at eight due to Tk issues.
Kurt B. Kaiseracdef852005-01-31 03:34:26 +00009Refer to comments in EditorWindow autoindent code for details.
Kurt B. Kaisere7a161e2003-01-10 20:13:57 +000010
Steven M. Gava44d3d1a2001-07-31 06:59:02 +000011"""
Tal Einat1ebee372019-07-23 13:02:11 +030012import re
13
Cheryl Sabella7028e592017-08-26 14:26:02 -040014from tkinter import (Toplevel, Listbox, Text, Scale, Canvas,
csabellabac7d332017-06-26 17:46:26 -040015 StringVar, BooleanVar, IntVar, TRUE, FALSE,
Terry Jan Reedye8f7c782017-11-28 21:52:32 -050016 TOP, BOTTOM, RIGHT, LEFT, SOLID, GROOVE,
17 NONE, BOTH, X, Y, W, E, EW, NS, NSEW, NW,
Louie Lubb2bae82017-07-10 06:57:18 +080018 HORIZONTAL, VERTICAL, ANCHOR, ACTIVE, END)
Terry Jan Reedyaff0ada2019-01-02 22:04:06 -050019from tkinter.ttk import (Frame, LabelFrame, Button, Checkbutton, Entry, Label,
wohlganger58fc71c2017-09-10 16:19:47 -050020 OptionMenu, Notebook, Radiobutton, Scrollbar, Style)
Georg Brandl14fc4272008-05-17 18:39:55 +000021import tkinter.colorchooser as tkColorChooser
22import tkinter.font as tkFont
Terry Jan Reedy3457f422017-08-27 16:39:41 -040023from tkinter import messagebox
Steven M. Gava44d3d1a2001-07-31 06:59:02 +000024
terryjreedy349abd92017-07-07 16:00:57 -040025from idlelib.config import idleConf, ConfigChanges
Terry Jan Reedy6fa5bdc2016-05-28 13:22:31 -040026from idlelib.config_key import GetKeysDialog
Terry Jan Reedybfbaa6b2016-08-31 00:50:55 -040027from idlelib.dynoption import DynOptionMenu
28from idlelib import macosx
Terry Jan Reedy8b22c0a2016-07-08 00:22:50 -040029from idlelib.query import SectionName, HelpSource
Terry Jan Reedy6fa5bdc2016-05-28 13:22:31 -040030from idlelib.textview import view_text
Terry Jan Reedy5777ecc2017-09-16 01:42:28 -040031from idlelib.autocomplete import AutoComplete
32from idlelib.codecontext import CodeContext
33from idlelib.parenmatch import ParenMatch
Cheryl Sabella82494aa2019-07-17 09:44:44 -040034from idlelib.format import FormatParagraph
Tal Einat604e7b92018-09-25 15:10:14 +030035from idlelib.squeezer import Squeezer
Tal Einat3221a632019-07-27 19:57:48 +030036from idlelib.textview import ScrollableTextFrame
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -040037
terryjreedy349abd92017-07-07 16:00:57 -040038changes = ConfigChanges()
Terry Jan Reedy5777ecc2017-09-16 01:42:28 -040039# Reload changed options in the following classes.
Tal Einat604e7b92018-09-25 15:10:14 +030040reloadables = (AutoComplete, CodeContext, ParenMatch, FormatParagraph,
41 Squeezer)
terryjreedy349abd92017-07-07 16:00:57 -040042
csabella5b591542017-07-28 14:40:59 -040043
Steven M. Gava44d3d1a2001-07-31 06:59:02 +000044class ConfigDialog(Toplevel):
csabella7eb58832017-07-04 21:30:58 -040045 """Config dialog for IDLE.
46 """
Kurt B. Kaiseracdef852005-01-31 03:34:26 +000047
Terry Jan Reedybfebfd82017-09-30 17:37:53 -040048 def __init__(self, parent, title='', *, _htest=False, _utest=False):
csabella7eb58832017-07-04 21:30:58 -040049 """Show the tabbed dialog for user configuration.
50
csabella36329a42017-07-13 23:32:01 -040051 Args:
52 parent - parent of this dialog
53 title - string which is the title of this popup dialog
54 _htest - bool, change box location when running htest
55 _utest - bool, don't wait_window when running unittest
56
57 Note: Focus set on font page fontlist.
58
59 Methods:
60 create_widgets
61 cancel: Bound to DELETE_WINDOW protocol.
Terry Jan Reedy2e8234a2014-05-29 01:46:26 -040062 """
Steven M. Gavad721c482001-07-31 10:46:53 +000063 Toplevel.__init__(self, parent)
Terry Jan Reedy22405332014-07-30 19:24:32 -040064 self.parent = parent
Terry Jan Reedy4036d872014-08-03 23:02:58 -040065 if _htest:
66 parent.instance_dict = {}
Louie Lu9b622fb2017-07-14 08:35:48 +080067 if not _utest:
68 self.withdraw()
Guido van Rossum8ce8a782007-11-01 19:42:39 +000069
Steven M. Gavad721c482001-07-31 10:46:53 +000070 self.configure(borderwidth=5)
Terry Jan Reedycd567362014-10-17 01:31:35 -040071 self.title(title or 'IDLE Preferences')
csabellabac7d332017-06-26 17:46:26 -040072 x = parent.winfo_rootx() + 20
73 y = parent.winfo_rooty() + (30 if not _htest else 150)
74 self.geometry(f'+{x}+{y}')
csabella7eb58832017-07-04 21:30:58 -040075 # Each theme element key is its display name.
76 # The first value of the tuple is the sample area tag name.
77 # The second value is the display name list sort index.
csabellabac7d332017-06-26 17:46:26 -040078 self.create_widgets()
Terry Jan Reedy4036d872014-08-03 23:02:58 -040079 self.resizable(height=FALSE, width=FALSE)
Steven M. Gavad721c482001-07-31 10:46:53 +000080 self.transient(parent)
csabellabac7d332017-06-26 17:46:26 -040081 self.protocol("WM_DELETE_WINDOW", self.cancel)
csabella9397e2a2017-07-30 13:34:25 -040082 self.fontpage.fontlist.focus_set()
csabella7eb58832017-07-04 21:30:58 -040083 # XXX Decide whether to keep or delete these key bindings.
84 # Key bindings for this dialog.
85 # self.bind('<Escape>', self.Cancel) #dismiss dialog, no save
86 # self.bind('<Alt-a>', self.Apply) #apply changes, save
87 # self.bind('<F1>', self.Help) #context help
Cheryl Sabella8f7a7982017-08-19 22:04:40 -040088 # Attach callbacks after loading config to avoid calling them.
csabella5b591542017-07-28 14:40:59 -040089 tracers.attach()
Guido van Rossum8ce8a782007-11-01 19:42:39 +000090
Terry Jan Reedycfa89502014-07-14 23:07:32 -040091 if not _utest:
Louie Lu9b622fb2017-07-14 08:35:48 +080092 self.grab_set()
Terry Jan Reedycfa89502014-07-14 23:07:32 -040093 self.wm_deiconify()
94 self.wait_window()
Kurt B. Kaiser6655e4b2002-12-31 16:03:23 +000095
csabellabac7d332017-06-26 17:46:26 -040096 def create_widgets(self):
csabella36329a42017-07-13 23:32:01 -040097 """Create and place widgets for tabbed dialog.
98
99 Widgets Bound to self:
csabellae8eb17b2017-07-30 18:39:17 -0400100 note: Notebook
Cheryl Sabella8f7a7982017-08-19 22:04:40 -0400101 highpage: HighPage
csabellae8eb17b2017-07-30 18:39:17 -0400102 fontpage: FontPage
Cheryl Sabellae36d9f52017-08-15 18:26:23 -0400103 keyspage: KeysPage
csabellae8eb17b2017-07-30 18:39:17 -0400104 genpage: GenPage
Cheryl Sabellae36d9f52017-08-15 18:26:23 -0400105 extpage: self.create_page_extensions
csabella36329a42017-07-13 23:32:01 -0400106
107 Methods:
csabella36329a42017-07-13 23:32:01 -0400108 create_action_buttons
109 load_configs: Load pages except for extensions.
csabella36329a42017-07-13 23:32:01 -0400110 activate_config_changes: Tell editors to reload.
111 """
Terry Jan Reedyd6e2f262017-09-19 19:01:45 -0400112 self.note = note = Notebook(self)
Cheryl Sabella8f7a7982017-08-19 22:04:40 -0400113 self.highpage = HighPage(note)
csabella9397e2a2017-07-30 13:34:25 -0400114 self.fontpage = FontPage(note, self.highpage)
Cheryl Sabellae36d9f52017-08-15 18:26:23 -0400115 self.keyspage = KeysPage(note)
csabellae8eb17b2017-07-30 18:39:17 -0400116 self.genpage = GenPage(note)
csabella9397e2a2017-07-30 13:34:25 -0400117 self.extpage = self.create_page_extensions()
118 note.add(self.fontpage, text='Fonts/Tabs')
119 note.add(self.highpage, text='Highlights')
120 note.add(self.keyspage, text=' Keys ')
121 note.add(self.genpage, text=' General ')
122 note.add(self.extpage, text='Extensions')
Terry Jan Reedyb331f802017-07-29 00:49:39 -0400123 note.enable_traversal()
124 note.pack(side=TOP, expand=TRUE, fill=BOTH)
Terry Jan Reedy92cb0a32014-10-08 20:29:13 -0400125 self.create_action_buttons().pack(side=BOTTOM)
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -0400126
Terry Jan Reedy92cb0a32014-10-08 20:29:13 -0400127 def create_action_buttons(self):
csabella36329a42017-07-13 23:32:01 -0400128 """Return frame of action buttons for dialog.
129
130 Methods:
131 ok
132 apply
133 cancel
134 help
135
136 Widget Structure:
137 outer: Frame
138 buttons: Frame
139 (no assignment): Button (ok)
140 (no assignment): Button (apply)
141 (no assignment): Button (cancel)
142 (no assignment): Button (help)
143 (no assignment): Frame
144 """
Terry Jan Reedy6fa5bdc2016-05-28 13:22:31 -0400145 if macosx.isAquaTk():
Terry Jan Reedye3416e62014-07-26 19:40:16 -0400146 # Changing the default padding on OSX results in unreadable
csabella7eb58832017-07-04 21:30:58 -0400147 # text in the buttons.
csabellabac7d332017-06-26 17:46:26 -0400148 padding_args = {}
Ronald Oussoren9e350042009-02-12 16:02:11 +0000149 else:
Cheryl Sabella7028e592017-08-26 14:26:02 -0400150 padding_args = {'padding': (6, 3)}
151 outer = Frame(self, padding=2)
152 buttons = Frame(outer, padding=2)
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -0400153 for txt, cmd in (
csabellabac7d332017-06-26 17:46:26 -0400154 ('Ok', self.ok),
155 ('Apply', self.apply),
156 ('Cancel', self.cancel),
157 ('Help', self.help)):
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -0400158 Button(buttons, text=txt, command=cmd, takefocus=FALSE,
csabellabac7d332017-06-26 17:46:26 -0400159 **padding_args).pack(side=LEFT, padx=5)
csabella7eb58832017-07-04 21:30:58 -0400160 # Add space above buttons.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -0400161 Frame(outer, height=2, borderwidth=0).pack(side=TOP)
162 buttons.pack(side=BOTTOM)
163 return outer
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -0400164
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400165 def ok(self):
166 """Apply config changes, then dismiss dialog.
167
168 Methods:
169 apply
170 destroy: inherited
171 """
172 self.apply()
173 self.destroy()
174
175 def apply(self):
176 """Apply config changes and leave dialog open.
177
178 Methods:
179 deactivate_current_config
180 save_all_changed_extensions
181 activate_config_changes
182 """
183 self.deactivate_current_config()
184 changes.save_all()
185 self.save_all_changed_extensions()
186 self.activate_config_changes()
187
188 def cancel(self):
189 """Dismiss config dialog.
190
191 Methods:
192 destroy: inherited
193 """
194 self.destroy()
195
Serhiy Storchakaed6554c2017-10-28 03:22:44 +0300196 def destroy(self):
197 global font_sample_text
198 font_sample_text = self.fontpage.font_sample.get('1.0', 'end')
Tal Einat10ea9402018-08-02 09:18:29 +0300199 self.grab_release()
Serhiy Storchakaed6554c2017-10-28 03:22:44 +0300200 super().destroy()
201
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400202 def help(self):
203 """Create textview for config dialog help.
204
Xtreakd9677f32019-06-03 09:51:15 +0530205 Attributes accessed:
Cheryl Sabella3866d9b2017-09-10 22:41:10 -0400206 note
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400207
208 Methods:
209 view_text: Method from textview module.
210 """
Cheryl Sabella3866d9b2017-09-10 22:41:10 -0400211 page = self.note.tab(self.note.select(), option='text').strip()
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400212 view_text(self, title='Help for IDLE preferences',
213 text=help_common+help_pages.get(page, ''))
214
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400215 def deactivate_current_config(self):
216 """Remove current key bindings.
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400217 Iterate over window instances defined in parent and remove
218 the keybindings.
219 """
220 # Before a config is saved, some cleanup of current
221 # config must be done - remove the previous keybindings.
222 win_instances = self.parent.instance_dict.keys()
223 for instance in win_instances:
224 instance.RemoveKeybindings()
225
226 def activate_config_changes(self):
227 """Apply configuration changes to current windows.
228
229 Dynamically update the current parent window instances
230 with some of the configuration changes.
231 """
232 win_instances = self.parent.instance_dict.keys()
233 for instance in win_instances:
234 instance.ResetColorizer()
235 instance.ResetFont()
236 instance.set_notabs_indentwidth()
237 instance.ApplyKeybindings()
238 instance.reset_help_menu_entries()
Terry Jan Reedy5777ecc2017-09-16 01:42:28 -0400239 for klass in reloadables:
240 klass.reload()
Terry Jan Reedyb1660802017-07-27 18:28:01 -0400241
csabellabac7d332017-06-26 17:46:26 -0400242 def create_page_extensions(self):
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400243 """Part of the config dialog used for configuring IDLE extensions.
244
245 This code is generic - it works for any and all IDLE extensions.
246
247 IDLE extensions save their configuration options using idleConf.
Terry Jan Reedyb2f87602015-10-13 22:09:06 -0400248 This code reads the current configuration using idleConf, supplies a
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400249 GUI interface to change the configuration values, and saves the
250 changes using idleConf.
251
252 Not all changes take effect immediately - some may require restarting IDLE.
253 This depends on each extension's implementation.
254
255 All values are treated as text, and it is up to the user to supply
256 reasonable values. The only exception to this are the 'enable*' options,
Serhiy Storchaka6a7b3a72016-04-17 08:32:47 +0300257 which are boolean, and can be toggled with a True/False button.
csabella36329a42017-07-13 23:32:01 -0400258
259 Methods:
Ville Skyttä49b27342017-08-03 09:00:59 +0300260 load_extensions:
csabella36329a42017-07-13 23:32:01 -0400261 extension_selected: Handle selection from list.
262 create_extension_frame: Hold widgets for one extension.
263 set_extension_value: Set in userCfg['extensions'].
264 save_all_changed_extensions: Call extension page Save().
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400265 """
266 parent = self.parent
Terry Jan Reedyb331f802017-07-29 00:49:39 -0400267 frame = Frame(self.note)
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400268 self.ext_defaultCfg = idleConf.defaultCfg['extensions']
269 self.ext_userCfg = idleConf.userCfg['extensions']
270 self.is_int = self.register(is_int)
271 self.load_extensions()
csabella7eb58832017-07-04 21:30:58 -0400272 # Create widgets - a listbox shows all available extensions, with the
273 # controls for the extension selected in the listbox to the right.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400274 self.extension_names = StringVar(self)
275 frame.rowconfigure(0, weight=1)
276 frame.columnconfigure(2, weight=1)
277 self.extension_list = Listbox(frame, listvariable=self.extension_names,
278 selectmode='browse')
279 self.extension_list.bind('<<ListboxSelect>>', self.extension_selected)
280 scroll = Scrollbar(frame, command=self.extension_list.yview)
281 self.extension_list.yscrollcommand=scroll.set
282 self.details_frame = LabelFrame(frame, width=250, height=250)
283 self.extension_list.grid(column=0, row=0, sticky='nws')
284 scroll.grid(column=1, row=0, sticky='ns')
285 self.details_frame.grid(column=2, row=0, sticky='nsew', padx=[10, 0])
Cheryl Sabella7028e592017-08-26 14:26:02 -0400286 frame.configure(padding=10)
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400287 self.config_frame = {}
288 self.current_extension = None
289
290 self.outerframe = self # TEMPORARY
291 self.tabbed_page_set = self.extension_list # TEMPORARY
292
csabella7eb58832017-07-04 21:30:58 -0400293 # Create the frame holding controls for each extension.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400294 ext_names = ''
295 for ext_name in sorted(self.extensions):
296 self.create_extension_frame(ext_name)
297 ext_names = ext_names + '{' + ext_name + '} '
298 self.extension_names.set(ext_names)
299 self.extension_list.selection_set(0)
300 self.extension_selected(None)
301
Terry Jan Reedyb331f802017-07-29 00:49:39 -0400302 return frame
303
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400304 def load_extensions(self):
305 "Fill self.extensions with data from the default and user configs."
306 self.extensions = {}
307 for ext_name in idleConf.GetExtensions(active_only=False):
wohlganger58fc71c2017-09-10 16:19:47 -0500308 # Former built-in extensions are already filtered out.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400309 self.extensions[ext_name] = []
310
311 for ext_name in self.extensions:
312 opt_list = sorted(self.ext_defaultCfg.GetOptionList(ext_name))
313
csabella7eb58832017-07-04 21:30:58 -0400314 # Bring 'enable' options to the beginning of the list.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400315 enables = [opt_name for opt_name in opt_list
316 if opt_name.startswith('enable')]
317 for opt_name in enables:
318 opt_list.remove(opt_name)
319 opt_list = enables + opt_list
320
321 for opt_name in opt_list:
322 def_str = self.ext_defaultCfg.Get(
323 ext_name, opt_name, raw=True)
324 try:
325 def_obj = {'True':True, 'False':False}[def_str]
326 opt_type = 'bool'
327 except KeyError:
328 try:
329 def_obj = int(def_str)
330 opt_type = 'int'
331 except ValueError:
332 def_obj = def_str
333 opt_type = None
334 try:
335 value = self.ext_userCfg.Get(
336 ext_name, opt_name, type=opt_type, raw=True,
337 default=def_obj)
csabella7eb58832017-07-04 21:30:58 -0400338 except ValueError: # Need this until .Get fixed.
339 value = def_obj # Bad values overwritten by entry.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400340 var = StringVar(self)
341 var.set(str(value))
342
343 self.extensions[ext_name].append({'name': opt_name,
344 'type': opt_type,
345 'default': def_str,
346 'value': value,
347 'var': var,
348 })
349
350 def extension_selected(self, event):
csabella7eb58832017-07-04 21:30:58 -0400351 "Handle selection of an extension from the list."
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400352 newsel = self.extension_list.curselection()
353 if newsel:
354 newsel = self.extension_list.get(newsel)
355 if newsel is None or newsel != self.current_extension:
356 if self.current_extension:
357 self.details_frame.config(text='')
358 self.config_frame[self.current_extension].grid_forget()
359 self.current_extension = None
360 if newsel:
361 self.details_frame.config(text=newsel)
362 self.config_frame[newsel].grid(column=0, row=0, sticky='nsew')
363 self.current_extension = newsel
364
365 def create_extension_frame(self, ext_name):
366 """Create a frame holding the widgets to configure one extension"""
367 f = VerticalScrolledFrame(self.details_frame, height=250, width=250)
368 self.config_frame[ext_name] = f
369 entry_area = f.interior
csabella7eb58832017-07-04 21:30:58 -0400370 # Create an entry for each configuration option.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400371 for row, opt in enumerate(self.extensions[ext_name]):
csabella7eb58832017-07-04 21:30:58 -0400372 # Create a row with a label and entry/checkbutton.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400373 label = Label(entry_area, text=opt['name'])
374 label.grid(row=row, column=0, sticky=NW)
375 var = opt['var']
376 if opt['type'] == 'bool':
Cheryl Sabella7028e592017-08-26 14:26:02 -0400377 Checkbutton(entry_area, variable=var,
378 onvalue='True', offvalue='False', width=8
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400379 ).grid(row=row, column=1, sticky=W, padx=7)
380 elif opt['type'] == 'int':
381 Entry(entry_area, textvariable=var, validate='key',
Terry Jan Reedy800415e2018-06-11 14:14:32 -0400382 validatecommand=(self.is_int, '%P'), width=10
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400383 ).grid(row=row, column=1, sticky=NSEW, padx=7)
384
Terry Jan Reedy800415e2018-06-11 14:14:32 -0400385 else: # type == 'str'
386 # Limit size to fit non-expanding space with larger font.
387 Entry(entry_area, textvariable=var, width=15
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400388 ).grid(row=row, column=1, sticky=NSEW, padx=7)
389 return
390
391 def set_extension_value(self, section, opt):
csabella7eb58832017-07-04 21:30:58 -0400392 """Return True if the configuration was added or changed.
393
394 If the value is the same as the default, then remove it
395 from user config file.
396 """
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400397 name = opt['name']
398 default = opt['default']
399 value = opt['var'].get().strip() or default
400 opt['var'].set(value)
401 # if self.defaultCfg.has_section(section):
csabella7eb58832017-07-04 21:30:58 -0400402 # Currently, always true; if not, indent to return.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400403 if (value == default):
404 return self.ext_userCfg.RemoveOption(section, name)
csabella7eb58832017-07-04 21:30:58 -0400405 # Set the option.
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400406 return self.ext_userCfg.SetOption(section, name, value)
407
408 def save_all_changed_extensions(self):
csabella36329a42017-07-13 23:32:01 -0400409 """Save configuration changes to the user config file.
410
411 Attributes accessed:
412 extensions
413
414 Methods:
415 set_extension_value
416 """
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400417 has_changes = False
418 for ext_name in self.extensions:
419 options = self.extensions[ext_name]
420 for opt in options:
421 if self.set_extension_value(ext_name, opt):
422 has_changes = True
423 if has_changes:
424 self.ext_userCfg.Save()
425
426
csabella6f446be2017-08-01 00:24:07 -0400427# class TabPage(Frame): # A template for Page classes.
428# def __init__(self, master):
429# super().__init__(master)
430# self.create_page_tab()
431# self.load_tab_cfg()
432# def create_page_tab(self):
433# # Define tk vars and register var and callback with tracers.
434# # Create subframes and widgets.
435# # Pack widgets.
436# def load_tab_cfg(self):
437# # Initialize widgets with data from idleConf.
438# def var_changed_var_name():
439# # For each tk var that needs other than default callback.
440# def other_methods():
441# # Define tab-specific behavior.
442
Serhiy Storchakaed6554c2017-10-28 03:22:44 +0300443font_sample_text = (
444 '<ASCII/Latin1>\n'
445 'AaBbCcDdEeFfGgHhIiJj\n1234567890#:+=(){}[]\n'
446 '\u00a2\u00a3\u00a5\u00a7\u00a9\u00ab\u00ae\u00b6\u00bd\u011e'
447 '\u00c0\u00c1\u00c2\u00c3\u00c4\u00c5\u00c7\u00d0\u00d8\u00df\n'
448 '\n<IPA,Greek,Cyrillic>\n'
449 '\u0250\u0255\u0258\u025e\u025f\u0264\u026b\u026e\u0270\u0277'
450 '\u027b\u0281\u0283\u0286\u028e\u029e\u02a2\u02ab\u02ad\u02af\n'
451 '\u0391\u03b1\u0392\u03b2\u0393\u03b3\u0394\u03b4\u0395\u03b5'
452 '\u0396\u03b6\u0397\u03b7\u0398\u03b8\u0399\u03b9\u039a\u03ba\n'
453 '\u0411\u0431\u0414\u0434\u0416\u0436\u041f\u043f\u0424\u0444'
454 '\u0427\u0447\u042a\u044a\u042d\u044d\u0460\u0464\u046c\u04dc\n'
455 '\n<Hebrew, Arabic>\n'
456 '\u05d0\u05d1\u05d2\u05d3\u05d4\u05d5\u05d6\u05d7\u05d8\u05d9'
457 '\u05da\u05db\u05dc\u05dd\u05de\u05df\u05e0\u05e1\u05e2\u05e3\n'
458 '\u0627\u0628\u062c\u062f\u0647\u0648\u0632\u062d\u0637\u064a'
459 '\u0660\u0661\u0662\u0663\u0664\u0665\u0666\u0667\u0668\u0669\n'
460 '\n<Devanagari, Tamil>\n'
461 '\u0966\u0967\u0968\u0969\u096a\u096b\u096c\u096d\u096e\u096f'
462 '\u0905\u0906\u0907\u0908\u0909\u090a\u090f\u0910\u0913\u0914\n'
463 '\u0be6\u0be7\u0be8\u0be9\u0bea\u0beb\u0bec\u0bed\u0bee\u0bef'
464 '\u0b85\u0b87\u0b89\u0b8e\n'
465 '\n<East Asian>\n'
466 '\u3007\u4e00\u4e8c\u4e09\u56db\u4e94\u516d\u4e03\u516b\u4e5d\n'
467 '\u6c49\u5b57\u6f22\u5b57\u4eba\u6728\u706b\u571f\u91d1\u6c34\n'
468 '\uac00\ub0d0\ub354\ub824\ubaa8\ubd64\uc218\uc720\uc988\uce58\n'
469 '\u3042\u3044\u3046\u3048\u304a\u30a2\u30a4\u30a6\u30a8\u30aa\n'
470 )
471
csabella6f446be2017-08-01 00:24:07 -0400472
csabella9397e2a2017-07-30 13:34:25 -0400473class FontPage(Frame):
474
csabella6f446be2017-08-01 00:24:07 -0400475 def __init__(self, master, highpage):
476 super().__init__(master)
csabella9397e2a2017-07-30 13:34:25 -0400477 self.highlight_sample = highpage.highlight_sample
478 self.create_page_font_tab()
479 self.load_font_cfg()
480 self.load_tab_cfg()
481
482 def create_page_font_tab(self):
483 """Return frame of widgets for Font/Tabs tab.
484
485 Fonts: Enable users to provisionally change font face, size, or
486 boldness and to see the consequence of proposed choices. Each
487 action set 3 options in changes structuree and changes the
488 corresponding aspect of the font sample on this page and
489 highlight sample on highlight page.
490
491 Function load_font_cfg initializes font vars and widgets from
492 idleConf entries and tk.
493
494 Fontlist: mouse button 1 click or up or down key invoke
495 on_fontlist_select(), which sets var font_name.
496
497 Sizelist: clicking the menubutton opens the dropdown menu. A
498 mouse button 1 click or return key sets var font_size.
499
500 Bold_toggle: clicking the box toggles var font_bold.
501
502 Changing any of the font vars invokes var_changed_font, which
503 adds all 3 font options to changes and calls set_samples.
504 Set_samples applies a new font constructed from the font vars to
Leo Ariasc3d95082018-02-03 18:36:10 -0600505 font_sample and to highlight_sample on the highlight page.
csabella9397e2a2017-07-30 13:34:25 -0400506
507 Tabs: Enable users to change spaces entered for indent tabs.
508 Changing indent_scale value with the mouse sets Var space_num,
509 which invokes the default callback to add an entry to
510 changes. Load_tab_cfg initializes space_num to default.
511
Cheryl Sabella2f896462017-08-14 21:21:43 -0400512 Widgets for FontPage(Frame): (*) widgets bound to self
513 frame_font: LabelFrame
514 frame_font_name: Frame
515 font_name_title: Label
516 (*)fontlist: ListBox - font_name
517 scroll_font: Scrollbar
518 frame_font_param: Frame
519 font_size_title: Label
520 (*)sizelist: DynOptionMenu - font_size
521 (*)bold_toggle: Checkbutton - font_bold
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400522 frame_sample: LabelFrame
523 (*)font_sample: Label
Cheryl Sabella2f896462017-08-14 21:21:43 -0400524 frame_indent: LabelFrame
525 indent_title: Label
526 (*)indent_scale: Scale - space_num
csabella9397e2a2017-07-30 13:34:25 -0400527 """
csabella6f446be2017-08-01 00:24:07 -0400528 self.font_name = tracers.add(StringVar(self), self.var_changed_font)
529 self.font_size = tracers.add(StringVar(self), self.var_changed_font)
530 self.font_bold = tracers.add(BooleanVar(self), self.var_changed_font)
csabella9397e2a2017-07-30 13:34:25 -0400531 self.space_num = tracers.add(IntVar(self), ('main', 'Indent', 'num-spaces'))
532
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400533 # Define frames and widgets.
csabella9397e2a2017-07-30 13:34:25 -0400534 frame_font = LabelFrame(
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400535 self, borderwidth=2, relief=GROOVE, text=' Shell/Editor Font ')
536 frame_sample = LabelFrame(
Serhiy Storchakaed6554c2017-10-28 03:22:44 +0300537 self, borderwidth=2, relief=GROOVE,
538 text=' Font Sample (Editable) ')
csabella9397e2a2017-07-30 13:34:25 -0400539 frame_indent = LabelFrame(
csabella6f446be2017-08-01 00:24:07 -0400540 self, borderwidth=2, relief=GROOVE, text=' Indentation Width ')
csabella9397e2a2017-07-30 13:34:25 -0400541 # frame_font.
542 frame_font_name = Frame(frame_font)
543 frame_font_param = Frame(frame_font)
544 font_name_title = Label(
545 frame_font_name, justify=LEFT, text='Font Face :')
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400546 self.fontlist = Listbox(frame_font_name, height=15,
csabella9397e2a2017-07-30 13:34:25 -0400547 takefocus=True, exportselection=FALSE)
548 self.fontlist.bind('<ButtonRelease-1>', self.on_fontlist_select)
549 self.fontlist.bind('<KeyRelease-Up>', self.on_fontlist_select)
550 self.fontlist.bind('<KeyRelease-Down>', self.on_fontlist_select)
551 scroll_font = Scrollbar(frame_font_name)
552 scroll_font.config(command=self.fontlist.yview)
553 self.fontlist.config(yscrollcommand=scroll_font.set)
554 font_size_title = Label(frame_font_param, text='Size :')
555 self.sizelist = DynOptionMenu(frame_font_param, self.font_size, None)
556 self.bold_toggle = Checkbutton(
557 frame_font_param, variable=self.font_bold,
558 onvalue=1, offvalue=0, text='Bold')
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400559 # frame_sample.
Tal Einat3221a632019-07-27 19:57:48 +0300560 font_sample_frame = ScrollableTextFrame(frame_sample)
561 self.font_sample = font_sample_frame.text
562 self.font_sample.config(wrap=NONE, width=1, height=1)
Serhiy Storchakaed6554c2017-10-28 03:22:44 +0300563 self.font_sample.insert(END, font_sample_text)
csabella9397e2a2017-07-30 13:34:25 -0400564 # frame_indent.
565 indent_title = Label(
566 frame_indent, justify=LEFT,
567 text='Python Standard: 4 Spaces!')
568 self.indent_scale = Scale(
569 frame_indent, variable=self.space_num,
570 orient='horizontal', tickinterval=2, from_=2, to=16)
571
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400572 # Grid and pack widgets:
573 self.columnconfigure(1, weight=1)
Tal Einat3221a632019-07-27 19:57:48 +0300574 self.rowconfigure(2, weight=1)
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400575 frame_font.grid(row=0, column=0, padx=5, pady=5)
Tal Einat3221a632019-07-27 19:57:48 +0300576 frame_sample.grid(row=0, column=1, rowspan=3, padx=5, pady=5,
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400577 sticky='nsew')
578 frame_indent.grid(row=1, column=0, padx=5, pady=5, sticky='ew')
csabella9397e2a2017-07-30 13:34:25 -0400579 # frame_font.
580 frame_font_name.pack(side=TOP, padx=5, pady=5, fill=X)
581 frame_font_param.pack(side=TOP, padx=5, pady=5, fill=X)
582 font_name_title.pack(side=TOP, anchor=W)
583 self.fontlist.pack(side=LEFT, expand=TRUE, fill=X)
584 scroll_font.pack(side=LEFT, fill=Y)
585 font_size_title.pack(side=LEFT, anchor=W)
586 self.sizelist.pack(side=LEFT, anchor=W)
587 self.bold_toggle.pack(side=LEFT, anchor=W, padx=20)
Terry Jan Reedye2e42272017-10-17 18:56:16 -0400588 # frame_sample.
Tal Einat3221a632019-07-27 19:57:48 +0300589 font_sample_frame.pack(expand=TRUE, fill=BOTH)
csabella9397e2a2017-07-30 13:34:25 -0400590 # frame_indent.
csabella9397e2a2017-07-30 13:34:25 -0400591 indent_title.pack(side=TOP, anchor=W, padx=5)
592 self.indent_scale.pack(side=TOP, padx=5, fill=X)
593
csabella9397e2a2017-07-30 13:34:25 -0400594 def load_font_cfg(self):
595 """Load current configuration settings for the font options.
596
597 Retrieve current font with idleConf.GetFont and font families
598 from tk. Setup fontlist and set font_name. Setup sizelist,
599 which sets font_size. Set font_bold. Call set_samples.
600 """
601 configured_font = idleConf.GetFont(self, 'main', 'EditorWindow')
602 font_name = configured_font[0].lower()
603 font_size = configured_font[1]
604 font_bold = configured_font[2]=='bold'
605
606 # Set editor font selection list and font_name.
607 fonts = list(tkFont.families(self))
608 fonts.sort()
609 for font in fonts:
610 self.fontlist.insert(END, font)
611 self.font_name.set(font_name)
612 lc_fonts = [s.lower() for s in fonts]
613 try:
614 current_font_index = lc_fonts.index(font_name)
615 self.fontlist.see(current_font_index)
616 self.fontlist.select_set(current_font_index)
617 self.fontlist.select_anchor(current_font_index)
618 self.fontlist.activate(current_font_index)
619 except ValueError:
620 pass
621 # Set font size dropdown.
622 self.sizelist.SetMenu(('7', '8', '9', '10', '11', '12', '13', '14',
623 '16', '18', '20', '22', '25', '29', '34', '40'),
624 font_size)
625 # Set font weight.
626 self.font_bold.set(font_bold)
627 self.set_samples()
628
629 def var_changed_font(self, *params):
630 """Store changes to font attributes.
631
632 When one font attribute changes, save them all, as they are
633 not independent from each other. In particular, when we are
634 overriding the default font, we need to write out everything.
635 """
636 value = self.font_name.get()
637 changes.add_option('main', 'EditorWindow', 'font', value)
638 value = self.font_size.get()
639 changes.add_option('main', 'EditorWindow', 'font-size', value)
640 value = self.font_bold.get()
641 changes.add_option('main', 'EditorWindow', 'font-bold', value)
642 self.set_samples()
643
644 def on_fontlist_select(self, event):
645 """Handle selecting a font from the list.
646
647 Event can result from either mouse click or Up or Down key.
648 Set font_name and example displays to selection.
649 """
650 font = self.fontlist.get(
651 ACTIVE if event.type.name == 'KeyRelease' else ANCHOR)
652 self.font_name.set(font.lower())
653
654 def set_samples(self, event=None):
655 """Update update both screen samples with the font settings.
656
657 Called on font initialization and change events.
658 Accesses font_name, font_size, and font_bold Variables.
Leo Ariasc3d95082018-02-03 18:36:10 -0600659 Updates font_sample and highlight page highlight_sample.
csabella9397e2a2017-07-30 13:34:25 -0400660 """
661 font_name = self.font_name.get()
662 font_weight = tkFont.BOLD if self.font_bold.get() else tkFont.NORMAL
663 new_font = (font_name, self.font_size.get(), font_weight)
664 self.font_sample['font'] = new_font
665 self.highlight_sample['font'] = new_font
666
667 def load_tab_cfg(self):
668 """Load current configuration settings for the tab options.
669
670 Attributes updated:
671 space_num: Set to value from idleConf.
672 """
673 # Set indent sizes.
674 space_num = idleConf.GetOption(
675 'main', 'Indent', 'num-spaces', default=4, type='int')
676 self.space_num.set(space_num)
677
678 def var_changed_space_num(self, *params):
679 "Store change to indentation size."
680 value = self.space_num.get()
681 changes.add_option('main', 'Indent', 'num-spaces', value)
682
683
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400684class HighPage(Frame):
685
686 def __init__(self, master):
687 super().__init__(master)
688 self.cd = master.master
Cheryl Sabella7028e592017-08-26 14:26:02 -0400689 self.style = Style(master)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400690 self.create_page_highlight()
691 self.load_theme_cfg()
692
693 def create_page_highlight(self):
694 """Return frame of widgets for Highlighting tab.
695
696 Enable users to provisionally change foreground and background
697 colors applied to textual tags. Color mappings are stored in
698 complete listings called themes. Built-in themes in
699 idlelib/config-highlight.def are fixed as far as the dialog is
700 concerned. Any theme can be used as the base for a new custom
701 theme, stored in .idlerc/config-highlight.cfg.
702
703 Function load_theme_cfg() initializes tk variables and theme
704 lists and calls paint_theme_sample() and set_highlight_target()
705 for the current theme. Radiobuttons builtin_theme_on and
706 custom_theme_on toggle var theme_source, which controls if the
707 current set of colors are from a builtin or custom theme.
708 DynOptionMenus builtinlist and customlist contain lists of the
709 builtin and custom themes, respectively, and the current item
710 from each list is stored in vars builtin_name and custom_name.
711
712 Function paint_theme_sample() applies the colors from the theme
713 to the tags in text widget highlight_sample and then invokes
714 set_color_sample(). Function set_highlight_target() sets the state
715 of the radiobuttons fg_on and bg_on based on the tag and it also
716 invokes set_color_sample().
717
718 Function set_color_sample() sets the background color for the frame
719 holding the color selector. This provides a larger visual of the
720 color for the current tag and plane (foreground/background).
721
722 Note: set_color_sample() is called from many places and is often
723 called more than once when a change is made. It is invoked when
724 foreground or background is selected (radiobuttons), from
725 paint_theme_sample() (theme is changed or load_cfg is called), and
726 from set_highlight_target() (target tag is changed or load_cfg called).
727
728 Button delete_custom invokes delete_custom() to delete
729 a custom theme from idleConf.userCfg['highlight'] and changes.
730 Button save_custom invokes save_as_new_theme() which calls
731 get_new_theme_name() and create_new() to save a custom theme
732 and its colors to idleConf.userCfg['highlight'].
733
734 Radiobuttons fg_on and bg_on toggle var fg_bg_toggle to control
735 if the current selected color for a tag is for the foreground or
736 background.
737
738 DynOptionMenu targetlist contains a readable description of the
739 tags applied to Python source within IDLE. Selecting one of the
740 tags from this list populates highlight_target, which has a callback
741 function set_highlight_target().
742
743 Text widget highlight_sample displays a block of text (which is
744 mock Python code) in which is embedded the defined tags and reflects
745 the color attributes of the current theme and changes for those tags.
746 Mouse button 1 allows for selection of a tag and updates
747 highlight_target with that tag value.
748
749 Note: The font in highlight_sample is set through the config in
750 the fonts tab.
751
752 In other words, a tag can be selected either from targetlist or
753 by clicking on the sample text within highlight_sample. The
754 plane (foreground/background) is selected via the radiobutton.
755 Together, these two (tag and plane) control what color is
756 shown in set_color_sample() for the current theme. Button set_color
757 invokes get_color() which displays a ColorChooser to change the
758 color for the selected tag/plane. If a new color is picked,
759 it will be saved to changes and the highlight_sample and
760 frame background will be updated.
761
762 Tk Variables:
763 color: Color of selected target.
764 builtin_name: Menu variable for built-in theme.
765 custom_name: Menu variable for custom theme.
766 fg_bg_toggle: Toggle for foreground/background color.
767 Note: this has no callback.
768 theme_source: Selector for built-in or custom theme.
769 highlight_target: Menu variable for the highlight tag target.
770
771 Instance Data Attributes:
772 theme_elements: Dictionary of tags for text highlighting.
773 The key is the display name and the value is a tuple of
774 (tag name, display sort order).
775
776 Methods [attachment]:
777 load_theme_cfg: Load current highlight colors.
778 get_color: Invoke colorchooser [button_set_color].
779 set_color_sample_binding: Call set_color_sample [fg_bg_toggle].
780 set_highlight_target: set fg_bg_toggle, set_color_sample().
781 set_color_sample: Set frame background to target.
782 on_new_color_set: Set new color and add option.
783 paint_theme_sample: Recolor sample.
784 get_new_theme_name: Get from popup.
785 create_new: Combine theme with changes and save.
786 save_as_new_theme: Save [button_save_custom].
787 set_theme_type: Command for [theme_source].
788 delete_custom: Activate default [button_delete_custom].
789 save_new: Save to userCfg['theme'] (is function).
790
791 Widgets of highlights page frame: (*) widgets bound to self
792 frame_custom: LabelFrame
793 (*)highlight_sample: Text
794 (*)frame_color_set: Frame
795 (*)button_set_color: Button
796 (*)targetlist: DynOptionMenu - highlight_target
797 frame_fg_bg_toggle: Frame
798 (*)fg_on: Radiobutton - fg_bg_toggle
799 (*)bg_on: Radiobutton - fg_bg_toggle
800 (*)button_save_custom: Button
801 frame_theme: LabelFrame
802 theme_type_title: Label
803 (*)builtin_theme_on: Radiobutton - theme_source
804 (*)custom_theme_on: Radiobutton - theme_source
805 (*)builtinlist: DynOptionMenu - builtin_name
806 (*)customlist: DynOptionMenu - custom_name
807 (*)button_delete_custom: Button
808 (*)theme_message: Label
809 """
810 self.theme_elements = {
811 'Normal Text': ('normal', '00'),
Cheryl Sabellade651622018-06-01 21:45:54 -0400812 'Code Context': ('context', '01'),
813 'Python Keywords': ('keyword', '02'),
814 'Python Definitions': ('definition', '03'),
815 'Python Builtins': ('builtin', '04'),
816 'Python Comments': ('comment', '05'),
817 'Python Strings': ('string', '06'),
818 'Selected Text': ('hilite', '07'),
819 'Found Text': ('hit', '08'),
820 'Cursor': ('cursor', '09'),
821 'Editor Breakpoint': ('break', '10'),
822 'Shell Normal Text': ('console', '11'),
823 'Shell Error Text': ('error', '12'),
824 'Shell Stdout Text': ('stdout', '13'),
825 'Shell Stderr Text': ('stderr', '14'),
Tal Einat7123ea02019-07-23 15:22:11 +0300826 'Line Number': ('linenumber', '16'),
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400827 }
828 self.builtin_name = tracers.add(
829 StringVar(self), self.var_changed_builtin_name)
830 self.custom_name = tracers.add(
831 StringVar(self), self.var_changed_custom_name)
832 self.fg_bg_toggle = BooleanVar(self)
833 self.color = tracers.add(
834 StringVar(self), self.var_changed_color)
835 self.theme_source = tracers.add(
836 BooleanVar(self), self.var_changed_theme_source)
837 self.highlight_target = tracers.add(
838 StringVar(self), self.var_changed_highlight_target)
839
840 # Create widgets:
841 # body frame and section frames.
842 frame_custom = LabelFrame(self, borderwidth=2, relief=GROOVE,
843 text=' Custom Highlighting ')
844 frame_theme = LabelFrame(self, borderwidth=2, relief=GROOVE,
845 text=' Highlighting Theme ')
846 # frame_custom.
Tal Einat3221a632019-07-27 19:57:48 +0300847 sample_frame = ScrollableTextFrame(
848 frame_custom, relief=SOLID, borderwidth=1)
849 text = self.highlight_sample = sample_frame.text
850 text.configure(
851 font=('courier', 12, ''), cursor='hand2', width=1, height=1,
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400852 takefocus=FALSE, highlightthickness=0, wrap=NONE)
853 text.bind('<Double-Button-1>', lambda e: 'break')
854 text.bind('<B1-Motion>', lambda e: 'break')
wohlganger58fc71c2017-09-10 16:19:47 -0500855 text_and_tags=(
856 ('\n', 'normal'),
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400857 ('#you can click here', 'comment'), ('\n', 'normal'),
858 ('#to choose items', 'comment'), ('\n', 'normal'),
Cheryl Sabellade651622018-06-01 21:45:54 -0400859 ('code context section', 'context'), ('\n\n', 'normal'),
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400860 ('def', 'keyword'), (' ', 'normal'),
861 ('func', 'definition'), ('(param):\n ', 'normal'),
862 ('"""string"""', 'string'), ('\n var0 = ', 'normal'),
863 ("'string'", 'string'), ('\n var1 = ', 'normal'),
864 ("'selected'", 'hilite'), ('\n var2 = ', 'normal'),
865 ("'found'", 'hit'), ('\n var3 = ', 'normal'),
866 ('list', 'builtin'), ('(', 'normal'),
867 ('None', 'keyword'), (')\n', 'normal'),
868 (' breakpoint("line")', 'break'), ('\n\n', 'normal'),
869 (' error ', 'error'), (' ', 'normal'),
870 ('cursor |', 'cursor'), ('\n ', 'normal'),
871 ('shell', 'console'), (' ', 'normal'),
872 ('stdout', 'stdout'), (' ', 'normal'),
873 ('stderr', 'stderr'), ('\n\n', 'normal'))
874 for texttag in text_and_tags:
875 text.insert(END, texttag[0], texttag[1])
Tal Einat7123ea02019-07-23 15:22:11 +0300876 n_lines = len(text.get('1.0', END).splitlines())
Tal Einat3221a632019-07-27 19:57:48 +0300877 for lineno in range(1, n_lines):
Tal Einat7123ea02019-07-23 15:22:11 +0300878 text.insert(f'{lineno}.0',
879 f'{lineno:{len(str(n_lines))}d} ',
880 'linenumber')
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400881 for element in self.theme_elements:
882 def tem(event, elem=element):
Cheryl Sabella8f7a7982017-08-19 22:04:40 -0400883 # event.widget.winfo_top_level().highlight_target.set(elem)
884 self.highlight_target.set(elem)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400885 text.tag_bind(
886 self.theme_elements[element][0], '<ButtonPress-1>', tem)
Cheryl Sabella7028e592017-08-26 14:26:02 -0400887 text['state'] = 'disabled'
888 self.style.configure('frame_color_set.TFrame', borderwidth=1,
889 relief='solid')
890 self.frame_color_set = Frame(frame_custom, style='frame_color_set.TFrame')
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400891 frame_fg_bg_toggle = Frame(frame_custom)
892 self.button_set_color = Button(
893 self.frame_color_set, text='Choose Color for :',
Cheryl Sabella7028e592017-08-26 14:26:02 -0400894 command=self.get_color)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400895 self.targetlist = DynOptionMenu(
896 self.frame_color_set, self.highlight_target, None,
897 highlightthickness=0) #, command=self.set_highlight_targetBinding
898 self.fg_on = Radiobutton(
899 frame_fg_bg_toggle, variable=self.fg_bg_toggle, value=1,
900 text='Foreground', command=self.set_color_sample_binding)
901 self.bg_on = Radiobutton(
902 frame_fg_bg_toggle, variable=self.fg_bg_toggle, value=0,
903 text='Background', command=self.set_color_sample_binding)
904 self.fg_bg_toggle.set(1)
905 self.button_save_custom = Button(
906 frame_custom, text='Save as New Custom Theme',
907 command=self.save_as_new_theme)
908 # frame_theme.
909 theme_type_title = Label(frame_theme, text='Select : ')
910 self.builtin_theme_on = Radiobutton(
911 frame_theme, variable=self.theme_source, value=1,
912 command=self.set_theme_type, text='a Built-in Theme')
913 self.custom_theme_on = Radiobutton(
914 frame_theme, variable=self.theme_source, value=0,
915 command=self.set_theme_type, text='a Custom Theme')
916 self.builtinlist = DynOptionMenu(
917 frame_theme, self.builtin_name, None, command=None)
918 self.customlist = DynOptionMenu(
919 frame_theme, self.custom_name, None, command=None)
920 self.button_delete_custom = Button(
921 frame_theme, text='Delete Custom Theme',
922 command=self.delete_custom)
Cheryl Sabella7028e592017-08-26 14:26:02 -0400923 self.theme_message = Label(frame_theme, borderwidth=2)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400924 # Pack widgets:
925 # body.
926 frame_custom.pack(side=LEFT, padx=5, pady=5, expand=TRUE, fill=BOTH)
wohlganger58fc71c2017-09-10 16:19:47 -0500927 frame_theme.pack(side=TOP, padx=5, pady=5, fill=X)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400928 # frame_custom.
Tal Einat3221a632019-07-27 19:57:48 +0300929 self.frame_color_set.pack(side=TOP, padx=5, pady=5, fill=X)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400930 frame_fg_bg_toggle.pack(side=TOP, padx=5, pady=0)
Tal Einat3221a632019-07-27 19:57:48 +0300931 sample_frame.pack(
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400932 side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH)
933 self.button_set_color.pack(side=TOP, expand=TRUE, fill=X, padx=8, pady=4)
934 self.targetlist.pack(side=TOP, expand=TRUE, fill=X, padx=8, pady=3)
935 self.fg_on.pack(side=LEFT, anchor=E)
936 self.bg_on.pack(side=RIGHT, anchor=W)
937 self.button_save_custom.pack(side=BOTTOM, fill=X, padx=5, pady=5)
938 # frame_theme.
939 theme_type_title.pack(side=TOP, anchor=W, padx=5, pady=5)
940 self.builtin_theme_on.pack(side=TOP, anchor=W, padx=5)
941 self.custom_theme_on.pack(side=TOP, anchor=W, padx=5, pady=2)
942 self.builtinlist.pack(side=TOP, fill=X, padx=5, pady=5)
943 self.customlist.pack(side=TOP, fill=X, anchor=W, padx=5, pady=5)
944 self.button_delete_custom.pack(side=TOP, fill=X, padx=5, pady=5)
945 self.theme_message.pack(side=TOP, fill=X, pady=5)
946
947 def load_theme_cfg(self):
948 """Load current configuration settings for the theme options.
949
950 Based on the theme_source toggle, the theme is set as
951 either builtin or custom and the initial widget values
952 reflect the current settings from idleConf.
953
954 Attributes updated:
955 theme_source: Set from idleConf.
956 builtinlist: List of default themes from idleConf.
957 customlist: List of custom themes from idleConf.
958 custom_theme_on: Disabled if there are no custom themes.
959 custom_theme: Message with additional information.
960 targetlist: Create menu from self.theme_elements.
961
962 Methods:
963 set_theme_type
964 paint_theme_sample
965 set_highlight_target
966 """
967 # Set current theme type radiobutton.
968 self.theme_source.set(idleConf.GetOption(
969 'main', 'Theme', 'default', type='bool', default=1))
970 # Set current theme.
971 current_option = idleConf.CurrentTheme()
972 # Load available theme option menus.
973 if self.theme_source.get(): # Default theme selected.
974 item_list = idleConf.GetSectionList('default', 'highlight')
975 item_list.sort()
976 self.builtinlist.SetMenu(item_list, current_option)
977 item_list = idleConf.GetSectionList('user', 'highlight')
978 item_list.sort()
979 if not item_list:
Cheryl Sabella7028e592017-08-26 14:26:02 -0400980 self.custom_theme_on.state(('disabled',))
Cheryl Sabellaa32e4052017-08-18 18:34:55 -0400981 self.custom_name.set('- no custom themes -')
982 else:
983 self.customlist.SetMenu(item_list, item_list[0])
984 else: # User theme selected.
985 item_list = idleConf.GetSectionList('user', 'highlight')
986 item_list.sort()
987 self.customlist.SetMenu(item_list, current_option)
988 item_list = idleConf.GetSectionList('default', 'highlight')
989 item_list.sort()
990 self.builtinlist.SetMenu(item_list, item_list[0])
991 self.set_theme_type()
992 # Load theme element option menu.
993 theme_names = list(self.theme_elements.keys())
994 theme_names.sort(key=lambda x: self.theme_elements[x][1])
995 self.targetlist.SetMenu(theme_names, theme_names[0])
996 self.paint_theme_sample()
997 self.set_highlight_target()
998
999 def var_changed_builtin_name(self, *params):
1000 """Process new builtin theme selection.
1001
1002 Add the changed theme's name to the changed_items and recreate
1003 the sample with the values from the selected theme.
1004 """
1005 old_themes = ('IDLE Classic', 'IDLE New')
1006 value = self.builtin_name.get()
1007 if value not in old_themes:
1008 if idleConf.GetOption('main', 'Theme', 'name') not in old_themes:
1009 changes.add_option('main', 'Theme', 'name', old_themes[0])
1010 changes.add_option('main', 'Theme', 'name2', value)
1011 self.theme_message['text'] = 'New theme, see Help'
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001012 else:
1013 changes.add_option('main', 'Theme', 'name', value)
1014 changes.add_option('main', 'Theme', 'name2', '')
1015 self.theme_message['text'] = ''
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001016 self.paint_theme_sample()
1017
1018 def var_changed_custom_name(self, *params):
1019 """Process new custom theme selection.
1020
1021 If a new custom theme is selected, add the name to the
1022 changed_items and apply the theme to the sample.
1023 """
1024 value = self.custom_name.get()
1025 if value != '- no custom themes -':
1026 changes.add_option('main', 'Theme', 'name', value)
1027 self.paint_theme_sample()
1028
1029 def var_changed_theme_source(self, *params):
1030 """Process toggle between builtin and custom theme.
1031
1032 Update the default toggle value and apply the newly
1033 selected theme type.
1034 """
1035 value = self.theme_source.get()
1036 changes.add_option('main', 'Theme', 'default', value)
1037 if value:
1038 self.var_changed_builtin_name()
1039 else:
1040 self.var_changed_custom_name()
1041
1042 def var_changed_color(self, *params):
1043 "Process change to color choice."
1044 self.on_new_color_set()
1045
1046 def var_changed_highlight_target(self, *params):
1047 "Process selection of new target tag for highlighting."
1048 self.set_highlight_target()
1049
1050 def set_theme_type(self):
1051 """Set available screen options based on builtin or custom theme.
1052
1053 Attributes accessed:
1054 theme_source
1055
1056 Attributes updated:
1057 builtinlist
1058 customlist
1059 button_delete_custom
1060 custom_theme_on
1061
1062 Called from:
1063 handler for builtin_theme_on and custom_theme_on
1064 delete_custom
1065 create_new
1066 load_theme_cfg
1067 """
1068 if self.theme_source.get():
Cheryl Sabella7028e592017-08-26 14:26:02 -04001069 self.builtinlist['state'] = 'normal'
1070 self.customlist['state'] = 'disabled'
1071 self.button_delete_custom.state(('disabled',))
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001072 else:
Cheryl Sabella7028e592017-08-26 14:26:02 -04001073 self.builtinlist['state'] = 'disabled'
1074 self.custom_theme_on.state(('!disabled',))
1075 self.customlist['state'] = 'normal'
1076 self.button_delete_custom.state(('!disabled',))
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001077
1078 def get_color(self):
1079 """Handle button to select a new color for the target tag.
1080
1081 If a new color is selected while using a builtin theme, a
1082 name must be supplied to create a custom theme.
1083
1084 Attributes accessed:
1085 highlight_target
1086 frame_color_set
1087 theme_source
1088
1089 Attributes updated:
1090 color
1091
1092 Methods:
1093 get_new_theme_name
1094 create_new
1095 """
1096 target = self.highlight_target.get()
Cheryl Sabella7028e592017-08-26 14:26:02 -04001097 prev_color = self.style.lookup(self.frame_color_set['style'],
1098 'background')
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001099 rgbTuplet, color_string = tkColorChooser.askcolor(
1100 parent=self, title='Pick new color for : '+target,
1101 initialcolor=prev_color)
1102 if color_string and (color_string != prev_color):
1103 # User didn't cancel and they chose a new color.
1104 if self.theme_source.get(): # Current theme is a built-in.
1105 message = ('Your changes will be saved as a new Custom Theme. '
1106 'Enter a name for your new Custom Theme below.')
1107 new_theme = self.get_new_theme_name(message)
1108 if not new_theme: # User cancelled custom theme creation.
1109 return
1110 else: # Create new custom theme based on previously active theme.
1111 self.create_new(new_theme)
1112 self.color.set(color_string)
1113 else: # Current theme is user defined.
1114 self.color.set(color_string)
1115
1116 def on_new_color_set(self):
1117 "Display sample of new color selection on the dialog."
1118 new_color = self.color.get()
Cheryl Sabella7028e592017-08-26 14:26:02 -04001119 self.style.configure('frame_color_set.TFrame', background=new_color)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001120 plane = 'foreground' if self.fg_bg_toggle.get() else 'background'
1121 sample_element = self.theme_elements[self.highlight_target.get()][0]
1122 self.highlight_sample.tag_config(sample_element, **{plane: new_color})
1123 theme = self.custom_name.get()
1124 theme_element = sample_element + '-' + plane
1125 changes.add_option('highlight', theme, theme_element, new_color)
1126
1127 def get_new_theme_name(self, message):
1128 "Return name of new theme from query popup."
1129 used_names = (idleConf.GetSectionList('user', 'highlight') +
1130 idleConf.GetSectionList('default', 'highlight'))
1131 new_theme = SectionName(
1132 self, 'New Custom Theme', message, used_names).result
1133 return new_theme
1134
1135 def save_as_new_theme(self):
1136 """Prompt for new theme name and create the theme.
1137
1138 Methods:
1139 get_new_theme_name
1140 create_new
1141 """
1142 new_theme_name = self.get_new_theme_name('New Theme Name:')
1143 if new_theme_name:
1144 self.create_new(new_theme_name)
1145
1146 def create_new(self, new_theme_name):
1147 """Create a new custom theme with the given name.
1148
1149 Create the new theme based on the previously active theme
1150 with the current changes applied. Once it is saved, then
1151 activate the new theme.
1152
1153 Attributes accessed:
1154 builtin_name
1155 custom_name
1156
1157 Attributes updated:
1158 customlist
1159 theme_source
1160
1161 Method:
1162 save_new
1163 set_theme_type
1164 """
1165 if self.theme_source.get():
1166 theme_type = 'default'
1167 theme_name = self.builtin_name.get()
1168 else:
1169 theme_type = 'user'
1170 theme_name = self.custom_name.get()
1171 new_theme = idleConf.GetThemeDict(theme_type, theme_name)
1172 # Apply any of the old theme's unsaved changes to the new theme.
1173 if theme_name in changes['highlight']:
1174 theme_changes = changes['highlight'][theme_name]
1175 for element in theme_changes:
1176 new_theme[element] = theme_changes[element]
1177 # Save the new theme.
1178 self.save_new(new_theme_name, new_theme)
1179 # Change GUI over to the new theme.
1180 custom_theme_list = idleConf.GetSectionList('user', 'highlight')
1181 custom_theme_list.sort()
1182 self.customlist.SetMenu(custom_theme_list, new_theme_name)
1183 self.theme_source.set(0)
1184 self.set_theme_type()
1185
1186 def set_highlight_target(self):
1187 """Set fg/bg toggle and color based on highlight tag target.
1188
1189 Instance variables accessed:
1190 highlight_target
1191
1192 Attributes updated:
1193 fg_on
1194 bg_on
1195 fg_bg_toggle
1196
1197 Methods:
1198 set_color_sample
1199
1200 Called from:
1201 var_changed_highlight_target
1202 load_theme_cfg
1203 """
1204 if self.highlight_target.get() == 'Cursor': # bg not possible
Cheryl Sabella7028e592017-08-26 14:26:02 -04001205 self.fg_on.state(('disabled',))
1206 self.bg_on.state(('disabled',))
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001207 self.fg_bg_toggle.set(1)
1208 else: # Both fg and bg can be set.
Cheryl Sabella7028e592017-08-26 14:26:02 -04001209 self.fg_on.state(('!disabled',))
1210 self.bg_on.state(('!disabled',))
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001211 self.fg_bg_toggle.set(1)
1212 self.set_color_sample()
1213
1214 def set_color_sample_binding(self, *args):
1215 """Change color sample based on foreground/background toggle.
1216
1217 Methods:
1218 set_color_sample
1219 """
1220 self.set_color_sample()
1221
1222 def set_color_sample(self):
1223 """Set the color of the frame background to reflect the selected target.
1224
1225 Instance variables accessed:
1226 theme_elements
1227 highlight_target
1228 fg_bg_toggle
1229 highlight_sample
1230
1231 Attributes updated:
1232 frame_color_set
1233 """
1234 # Set the color sample area.
1235 tag = self.theme_elements[self.highlight_target.get()][0]
1236 plane = 'foreground' if self.fg_bg_toggle.get() else 'background'
1237 color = self.highlight_sample.tag_cget(tag, plane)
Cheryl Sabella7028e592017-08-26 14:26:02 -04001238 self.style.configure('frame_color_set.TFrame', background=color)
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001239
1240 def paint_theme_sample(self):
1241 """Apply the theme colors to each element tag in the sample text.
1242
1243 Instance attributes accessed:
1244 theme_elements
1245 theme_source
1246 builtin_name
1247 custom_name
1248
1249 Attributes updated:
1250 highlight_sample: Set the tag elements to the theme.
1251
1252 Methods:
1253 set_color_sample
1254
1255 Called from:
1256 var_changed_builtin_name
1257 var_changed_custom_name
1258 load_theme_cfg
1259 """
1260 if self.theme_source.get(): # Default theme
1261 theme = self.builtin_name.get()
1262 else: # User theme
1263 theme = self.custom_name.get()
1264 for element_title in self.theme_elements:
1265 element = self.theme_elements[element_title][0]
1266 colors = idleConf.GetHighlight(theme, element)
1267 if element == 'cursor': # Cursor sample needs special painting.
1268 colors['background'] = idleConf.GetHighlight(
Terry Jan Reedyc1419572019-03-22 18:23:41 -04001269 theme, 'normal')['background']
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001270 # Handle any unsaved changes to this theme.
1271 if theme in changes['highlight']:
1272 theme_dict = changes['highlight'][theme]
1273 if element + '-foreground' in theme_dict:
1274 colors['foreground'] = theme_dict[element + '-foreground']
1275 if element + '-background' in theme_dict:
1276 colors['background'] = theme_dict[element + '-background']
1277 self.highlight_sample.tag_config(element, **colors)
1278 self.set_color_sample()
1279
1280 def save_new(self, theme_name, theme):
1281 """Save a newly created theme to idleConf.
1282
1283 theme_name - string, the name of the new theme
1284 theme - dictionary containing the new theme
1285 """
1286 if not idleConf.userCfg['highlight'].has_section(theme_name):
1287 idleConf.userCfg['highlight'].add_section(theme_name)
1288 for element in theme:
1289 value = theme[element]
1290 idleConf.userCfg['highlight'].SetOption(theme_name, element, value)
1291
Terry Jan Reedy3457f422017-08-27 16:39:41 -04001292 def askyesno(self, *args, **kwargs):
1293 # Make testing easier. Could change implementation.
Terry Jan Reedy0efc7c62017-09-17 20:13:25 -04001294 return messagebox.askyesno(*args, **kwargs)
Terry Jan Reedy3457f422017-08-27 16:39:41 -04001295
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001296 def delete_custom(self):
1297 """Handle event to delete custom theme.
1298
1299 The current theme is deactivated and the default theme is
1300 activated. The custom theme is permanently removed from
1301 the config file.
1302
1303 Attributes accessed:
1304 custom_name
1305
1306 Attributes updated:
1307 custom_theme_on
1308 customlist
1309 theme_source
1310 builtin_name
1311
1312 Methods:
1313 deactivate_current_config
1314 save_all_changed_extensions
1315 activate_config_changes
1316 set_theme_type
1317 """
1318 theme_name = self.custom_name.get()
1319 delmsg = 'Are you sure you wish to delete the theme %r ?'
Terry Jan Reedy3457f422017-08-27 16:39:41 -04001320 if not self.askyesno(
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001321 'Delete Theme', delmsg % theme_name, parent=self):
1322 return
Cheryl Sabella8f7a7982017-08-19 22:04:40 -04001323 self.cd.deactivate_current_config()
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001324 # Remove theme from changes, config, and file.
1325 changes.delete_section('highlight', theme_name)
1326 # Reload user theme list.
1327 item_list = idleConf.GetSectionList('user', 'highlight')
1328 item_list.sort()
1329 if not item_list:
Cheryl Sabella7028e592017-08-26 14:26:02 -04001330 self.custom_theme_on.state(('disabled',))
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001331 self.customlist.SetMenu(item_list, '- no custom themes -')
1332 else:
1333 self.customlist.SetMenu(item_list, item_list[0])
1334 # Revert to default theme.
1335 self.theme_source.set(idleConf.defaultCfg['main'].Get('Theme', 'default'))
1336 self.builtin_name.set(idleConf.defaultCfg['main'].Get('Theme', 'name'))
1337 # User can't back out of these changes, they must be applied now.
1338 changes.save_all()
Cheryl Sabella8f7a7982017-08-19 22:04:40 -04001339 self.cd.save_all_changed_extensions()
1340 self.cd.activate_config_changes()
Cheryl Sabellaa32e4052017-08-18 18:34:55 -04001341 self.set_theme_type()
1342
1343
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001344class KeysPage(Frame):
1345
1346 def __init__(self, master):
1347 super().__init__(master)
1348 self.cd = master.master
1349 self.create_page_keys()
1350 self.load_key_cfg()
1351
1352 def create_page_keys(self):
1353 """Return frame of widgets for Keys tab.
1354
1355 Enable users to provisionally change both individual and sets of
1356 keybindings (shortcut keys). Except for features implemented as
1357 extensions, keybindings are stored in complete sets called
1358 keysets. Built-in keysets in idlelib/config-keys.def are fixed
1359 as far as the dialog is concerned. Any keyset can be used as the
1360 base for a new custom keyset, stored in .idlerc/config-keys.cfg.
1361
1362 Function load_key_cfg() initializes tk variables and keyset
1363 lists and calls load_keys_list for the current keyset.
1364 Radiobuttons builtin_keyset_on and custom_keyset_on toggle var
1365 keyset_source, which controls if the current set of keybindings
1366 are from a builtin or custom keyset. DynOptionMenus builtinlist
1367 and customlist contain lists of the builtin and custom keysets,
1368 respectively, and the current item from each list is stored in
1369 vars builtin_name and custom_name.
1370
1371 Button delete_custom_keys invokes delete_custom_keys() to delete
1372 a custom keyset from idleConf.userCfg['keys'] and changes. Button
1373 save_custom_keys invokes save_as_new_key_set() which calls
1374 get_new_keys_name() and create_new_key_set() to save a custom keyset
1375 and its keybindings to idleConf.userCfg['keys'].
1376
1377 Listbox bindingslist contains all of the keybindings for the
1378 selected keyset. The keybindings are loaded in load_keys_list()
1379 and are pairs of (event, [keys]) where keys can be a list
1380 of one or more key combinations to bind to the same event.
1381 Mouse button 1 click invokes on_bindingslist_select(), which
1382 allows button_new_keys to be clicked.
1383
1384 So, an item is selected in listbindings, which activates
1385 button_new_keys, and clicking button_new_keys calls function
1386 get_new_keys(). Function get_new_keys() gets the key mappings from the
1387 current keyset for the binding event item that was selected. The
1388 function then displays another dialog, GetKeysDialog, with the
Cheryl Sabella82aff622017-08-17 20:39:00 -04001389 selected binding event and current keys and allows new key sequences
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001390 to be entered for that binding event. If the keys aren't
1391 changed, nothing happens. If the keys are changed and the keyset
1392 is a builtin, function get_new_keys_name() will be called
1393 for input of a custom keyset name. If no name is given, then the
1394 change to the keybinding will abort and no updates will be made. If
1395 a custom name is entered in the prompt or if the current keyset was
1396 already custom (and thus didn't require a prompt), then
1397 idleConf.userCfg['keys'] is updated in function create_new_key_set()
1398 with the change to the event binding. The item listing in bindingslist
1399 is updated with the new keys. Var keybinding is also set which invokes
1400 the callback function, var_changed_keybinding, to add the change to
1401 the 'keys' or 'extensions' changes tracker based on the binding type.
1402
1403 Tk Variables:
1404 keybinding: Action/key bindings.
1405
1406 Methods:
1407 load_keys_list: Reload active set.
1408 create_new_key_set: Combine active keyset and changes.
1409 set_keys_type: Command for keyset_source.
1410 save_new_key_set: Save to idleConf.userCfg['keys'] (is function).
1411 deactivate_current_config: Remove keys bindings in editors.
1412
1413 Widgets for KeysPage(frame): (*) widgets bound to self
1414 frame_key_sets: LabelFrame
1415 frames[0]: Frame
1416 (*)builtin_keyset_on: Radiobutton - var keyset_source
1417 (*)custom_keyset_on: Radiobutton - var keyset_source
1418 (*)builtinlist: DynOptionMenu - var builtin_name,
1419 func keybinding_selected
1420 (*)customlist: DynOptionMenu - var custom_name,
1421 func keybinding_selected
1422 (*)keys_message: Label
1423 frames[1]: Frame
1424 (*)button_delete_custom_keys: Button - delete_custom_keys
1425 (*)button_save_custom_keys: Button - save_as_new_key_set
1426 frame_custom: LabelFrame
1427 frame_target: Frame
1428 target_title: Label
1429 scroll_target_y: Scrollbar
1430 scroll_target_x: Scrollbar
1431 (*)bindingslist: ListBox - on_bindingslist_select
1432 (*)button_new_keys: Button - get_new_keys & ..._name
1433 """
1434 self.builtin_name = tracers.add(
1435 StringVar(self), self.var_changed_builtin_name)
1436 self.custom_name = tracers.add(
1437 StringVar(self), self.var_changed_custom_name)
1438 self.keyset_source = tracers.add(
1439 BooleanVar(self), self.var_changed_keyset_source)
1440 self.keybinding = tracers.add(
1441 StringVar(self), self.var_changed_keybinding)
1442
1443 # Create widgets:
1444 # body and section frames.
1445 frame_custom = LabelFrame(
1446 self, borderwidth=2, relief=GROOVE,
1447 text=' Custom Key Bindings ')
1448 frame_key_sets = LabelFrame(
1449 self, borderwidth=2, relief=GROOVE, text=' Key Set ')
1450 # frame_custom.
1451 frame_target = Frame(frame_custom)
1452 target_title = Label(frame_target, text='Action - Key(s)')
1453 scroll_target_y = Scrollbar(frame_target)
1454 scroll_target_x = Scrollbar(frame_target, orient=HORIZONTAL)
1455 self.bindingslist = Listbox(
1456 frame_target, takefocus=FALSE, exportselection=FALSE)
1457 self.bindingslist.bind('<ButtonRelease-1>',
1458 self.on_bindingslist_select)
1459 scroll_target_y['command'] = self.bindingslist.yview
1460 scroll_target_x['command'] = self.bindingslist.xview
1461 self.bindingslist['yscrollcommand'] = scroll_target_y.set
1462 self.bindingslist['xscrollcommand'] = scroll_target_x.set
1463 self.button_new_keys = Button(
1464 frame_custom, text='Get New Keys for Selection',
Terry Jan Reedye8f7c782017-11-28 21:52:32 -05001465 command=self.get_new_keys, state='disabled')
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001466 # frame_key_sets.
Cheryl Sabella7028e592017-08-26 14:26:02 -04001467 frames = [Frame(frame_key_sets, padding=2, borderwidth=0)
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001468 for i in range(2)]
1469 self.builtin_keyset_on = Radiobutton(
1470 frames[0], variable=self.keyset_source, value=1,
1471 command=self.set_keys_type, text='Use a Built-in Key Set')
1472 self.custom_keyset_on = Radiobutton(
1473 frames[0], variable=self.keyset_source, value=0,
1474 command=self.set_keys_type, text='Use a Custom Key Set')
1475 self.builtinlist = DynOptionMenu(
1476 frames[0], self.builtin_name, None, command=None)
1477 self.customlist = DynOptionMenu(
1478 frames[0], self.custom_name, None, command=None)
1479 self.button_delete_custom_keys = Button(
1480 frames[1], text='Delete Custom Key Set',
1481 command=self.delete_custom_keys)
1482 self.button_save_custom_keys = Button(
1483 frames[1], text='Save as New Custom Key Set',
1484 command=self.save_as_new_key_set)
Cheryl Sabella7028e592017-08-26 14:26:02 -04001485 self.keys_message = Label(frames[0], borderwidth=2)
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001486
1487 # Pack widgets:
1488 # body.
1489 frame_custom.pack(side=BOTTOM, padx=5, pady=5, expand=TRUE, fill=BOTH)
1490 frame_key_sets.pack(side=BOTTOM, padx=5, pady=5, fill=BOTH)
1491 # frame_custom.
1492 self.button_new_keys.pack(side=BOTTOM, fill=X, padx=5, pady=5)
1493 frame_target.pack(side=LEFT, padx=5, pady=5, expand=TRUE, fill=BOTH)
1494 # frame_target.
1495 frame_target.columnconfigure(0, weight=1)
1496 frame_target.rowconfigure(1, weight=1)
1497 target_title.grid(row=0, column=0, columnspan=2, sticky=W)
1498 self.bindingslist.grid(row=1, column=0, sticky=NSEW)
1499 scroll_target_y.grid(row=1, column=1, sticky=NS)
1500 scroll_target_x.grid(row=2, column=0, sticky=EW)
1501 # frame_key_sets.
1502 self.builtin_keyset_on.grid(row=0, column=0, sticky=W+NS)
1503 self.custom_keyset_on.grid(row=1, column=0, sticky=W+NS)
1504 self.builtinlist.grid(row=0, column=1, sticky=NSEW)
1505 self.customlist.grid(row=1, column=1, sticky=NSEW)
1506 self.keys_message.grid(row=0, column=2, sticky=NSEW, padx=5, pady=5)
1507 self.button_delete_custom_keys.pack(side=LEFT, fill=X, expand=True, padx=2)
1508 self.button_save_custom_keys.pack(side=LEFT, fill=X, expand=True, padx=2)
1509 frames[0].pack(side=TOP, fill=BOTH, expand=True)
1510 frames[1].pack(side=TOP, fill=X, expand=True, pady=2)
1511
1512 def load_key_cfg(self):
1513 "Load current configuration settings for the keybinding options."
1514 # Set current keys type radiobutton.
1515 self.keyset_source.set(idleConf.GetOption(
1516 'main', 'Keys', 'default', type='bool', default=1))
1517 # Set current keys.
1518 current_option = idleConf.CurrentKeys()
1519 # Load available keyset option menus.
1520 if self.keyset_source.get(): # Default theme selected.
1521 item_list = idleConf.GetSectionList('default', 'keys')
1522 item_list.sort()
1523 self.builtinlist.SetMenu(item_list, current_option)
1524 item_list = idleConf.GetSectionList('user', 'keys')
1525 item_list.sort()
1526 if not item_list:
Cheryl Sabella7028e592017-08-26 14:26:02 -04001527 self.custom_keyset_on.state(('disabled',))
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001528 self.custom_name.set('- no custom keys -')
1529 else:
1530 self.customlist.SetMenu(item_list, item_list[0])
1531 else: # User key set selected.
1532 item_list = idleConf.GetSectionList('user', 'keys')
1533 item_list.sort()
1534 self.customlist.SetMenu(item_list, current_option)
1535 item_list = idleConf.GetSectionList('default', 'keys')
1536 item_list.sort()
1537 self.builtinlist.SetMenu(item_list, idleConf.default_keys())
1538 self.set_keys_type()
1539 # Load keyset element list.
1540 keyset_name = idleConf.CurrentKeys()
1541 self.load_keys_list(keyset_name)
1542
1543 def var_changed_builtin_name(self, *params):
1544 "Process selection of builtin key set."
1545 old_keys = (
1546 'IDLE Classic Windows',
1547 'IDLE Classic Unix',
1548 'IDLE Classic Mac',
1549 'IDLE Classic OSX',
1550 )
1551 value = self.builtin_name.get()
1552 if value not in old_keys:
1553 if idleConf.GetOption('main', 'Keys', 'name') not in old_keys:
1554 changes.add_option('main', 'Keys', 'name', old_keys[0])
1555 changes.add_option('main', 'Keys', 'name2', value)
1556 self.keys_message['text'] = 'New key set, see Help'
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001557 else:
1558 changes.add_option('main', 'Keys', 'name', value)
1559 changes.add_option('main', 'Keys', 'name2', '')
1560 self.keys_message['text'] = ''
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001561 self.load_keys_list(value)
1562
1563 def var_changed_custom_name(self, *params):
1564 "Process selection of custom key set."
1565 value = self.custom_name.get()
1566 if value != '- no custom keys -':
1567 changes.add_option('main', 'Keys', 'name', value)
1568 self.load_keys_list(value)
1569
1570 def var_changed_keyset_source(self, *params):
1571 "Process toggle between builtin key set and custom key set."
1572 value = self.keyset_source.get()
1573 changes.add_option('main', 'Keys', 'default', value)
1574 if value:
1575 self.var_changed_builtin_name()
1576 else:
1577 self.var_changed_custom_name()
1578
1579 def var_changed_keybinding(self, *params):
1580 "Store change to a keybinding."
1581 value = self.keybinding.get()
1582 key_set = self.custom_name.get()
1583 event = self.bindingslist.get(ANCHOR).split()[0]
1584 if idleConf.IsCoreBinding(event):
1585 changes.add_option('keys', key_set, event, value)
1586 else: # Event is an extension binding.
1587 ext_name = idleConf.GetExtnNameForEvent(event)
1588 ext_keybind_section = ext_name + '_cfgBindings'
1589 changes.add_option('extensions', ext_keybind_section, event, value)
1590
1591 def set_keys_type(self):
1592 "Set available screen options based on builtin or custom key set."
1593 if self.keyset_source.get():
Cheryl Sabella7028e592017-08-26 14:26:02 -04001594 self.builtinlist['state'] = 'normal'
1595 self.customlist['state'] = 'disabled'
1596 self.button_delete_custom_keys.state(('disabled',))
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001597 else:
Cheryl Sabella7028e592017-08-26 14:26:02 -04001598 self.builtinlist['state'] = 'disabled'
1599 self.custom_keyset_on.state(('!disabled',))
1600 self.customlist['state'] = 'normal'
1601 self.button_delete_custom_keys.state(('!disabled',))
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001602
1603 def get_new_keys(self):
1604 """Handle event to change key binding for selected line.
1605
1606 A selection of a key/binding in the list of current
1607 bindings pops up a dialog to enter a new binding. If
1608 the current key set is builtin and a binding has
1609 changed, then a name for a custom key set needs to be
1610 entered for the change to be applied.
1611 """
1612 list_index = self.bindingslist.index(ANCHOR)
1613 binding = self.bindingslist.get(list_index)
1614 bind_name = binding.split()[0]
1615 if self.keyset_source.get():
1616 current_key_set_name = self.builtin_name.get()
1617 else:
1618 current_key_set_name = self.custom_name.get()
1619 current_bindings = idleConf.GetCurrentKeySet()
1620 if current_key_set_name in changes['keys']: # unsaved changes
1621 key_set_changes = changes['keys'][current_key_set_name]
1622 for event in key_set_changes:
1623 current_bindings[event] = key_set_changes[event].split()
1624 current_key_sequences = list(current_bindings.values())
1625 new_keys = GetKeysDialog(self, 'Get New Keys', bind_name,
1626 current_key_sequences).result
1627 if new_keys:
1628 if self.keyset_source.get(): # Current key set is a built-in.
1629 message = ('Your changes will be saved as a new Custom Key Set.'
1630 ' Enter a name for your new Custom Key Set below.')
1631 new_keyset = self.get_new_keys_name(message)
1632 if not new_keyset: # User cancelled custom key set creation.
1633 self.bindingslist.select_set(list_index)
1634 self.bindingslist.select_anchor(list_index)
1635 return
1636 else: # Create new custom key set based on previously active key set.
1637 self.create_new_key_set(new_keyset)
1638 self.bindingslist.delete(list_index)
1639 self.bindingslist.insert(list_index, bind_name+' - '+new_keys)
1640 self.bindingslist.select_set(list_index)
1641 self.bindingslist.select_anchor(list_index)
1642 self.keybinding.set(new_keys)
1643 else:
1644 self.bindingslist.select_set(list_index)
1645 self.bindingslist.select_anchor(list_index)
1646
1647 def get_new_keys_name(self, message):
1648 "Return new key set name from query popup."
1649 used_names = (idleConf.GetSectionList('user', 'keys') +
1650 idleConf.GetSectionList('default', 'keys'))
1651 new_keyset = SectionName(
1652 self, 'New Custom Key Set', message, used_names).result
1653 return new_keyset
1654
1655 def save_as_new_key_set(self):
1656 "Prompt for name of new key set and save changes using that name."
1657 new_keys_name = self.get_new_keys_name('New Key Set Name:')
1658 if new_keys_name:
1659 self.create_new_key_set(new_keys_name)
1660
1661 def on_bindingslist_select(self, event):
1662 "Activate button to assign new keys to selected action."
Cheryl Sabella7028e592017-08-26 14:26:02 -04001663 self.button_new_keys.state(('!disabled',))
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001664
1665 def create_new_key_set(self, new_key_set_name):
1666 """Create a new custom key set with the given name.
1667
1668 Copy the bindings/keys from the previously active keyset
1669 to the new keyset and activate the new custom keyset.
1670 """
1671 if self.keyset_source.get():
1672 prev_key_set_name = self.builtin_name.get()
1673 else:
1674 prev_key_set_name = self.custom_name.get()
1675 prev_keys = idleConf.GetCoreKeys(prev_key_set_name)
1676 new_keys = {}
1677 for event in prev_keys: # Add key set to changed items.
1678 event_name = event[2:-2] # Trim off the angle brackets.
1679 binding = ' '.join(prev_keys[event])
1680 new_keys[event_name] = binding
1681 # Handle any unsaved changes to prev key set.
1682 if prev_key_set_name in changes['keys']:
1683 key_set_changes = changes['keys'][prev_key_set_name]
1684 for event in key_set_changes:
1685 new_keys[event] = key_set_changes[event]
1686 # Save the new key set.
1687 self.save_new_key_set(new_key_set_name, new_keys)
1688 # Change GUI over to the new key set.
1689 custom_key_list = idleConf.GetSectionList('user', 'keys')
1690 custom_key_list.sort()
1691 self.customlist.SetMenu(custom_key_list, new_key_set_name)
1692 self.keyset_source.set(0)
1693 self.set_keys_type()
1694
1695 def load_keys_list(self, keyset_name):
1696 """Reload the list of action/key binding pairs for the active key set.
1697
1698 An action/key binding can be selected to change the key binding.
1699 """
1700 reselect = False
1701 if self.bindingslist.curselection():
1702 reselect = True
1703 list_index = self.bindingslist.index(ANCHOR)
1704 keyset = idleConf.GetKeySet(keyset_name)
1705 bind_names = list(keyset.keys())
1706 bind_names.sort()
1707 self.bindingslist.delete(0, END)
1708 for bind_name in bind_names:
1709 key = ' '.join(keyset[bind_name])
1710 bind_name = bind_name[2:-2] # Trim off the angle brackets.
1711 if keyset_name in changes['keys']:
1712 # Handle any unsaved changes to this key set.
1713 if bind_name in changes['keys'][keyset_name]:
1714 key = changes['keys'][keyset_name][bind_name]
1715 self.bindingslist.insert(END, bind_name+' - '+key)
1716 if reselect:
1717 self.bindingslist.see(list_index)
1718 self.bindingslist.select_set(list_index)
1719 self.bindingslist.select_anchor(list_index)
1720
1721 @staticmethod
1722 def save_new_key_set(keyset_name, keyset):
1723 """Save a newly created core key set.
1724
1725 Add keyset to idleConf.userCfg['keys'], not to disk.
1726 If the keyset doesn't exist, it is created. The
1727 binding/keys are taken from the keyset argument.
1728
1729 keyset_name - string, the name of the new key set
1730 keyset - dictionary containing the new keybindings
1731 """
1732 if not idleConf.userCfg['keys'].has_section(keyset_name):
1733 idleConf.userCfg['keys'].add_section(keyset_name)
1734 for event in keyset:
1735 value = keyset[event]
1736 idleConf.userCfg['keys'].SetOption(keyset_name, event, value)
1737
Terry Jan Reedy3457f422017-08-27 16:39:41 -04001738 def askyesno(self, *args, **kwargs):
1739 # Make testing easier. Could change implementation.
Terry Jan Reedy0efc7c62017-09-17 20:13:25 -04001740 return messagebox.askyesno(*args, **kwargs)
Terry Jan Reedy3457f422017-08-27 16:39:41 -04001741
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001742 def delete_custom_keys(self):
1743 """Handle event to delete a custom key set.
1744
1745 Applying the delete deactivates the current configuration and
1746 reverts to the default. The custom key set is permanently
1747 deleted from the config file.
1748 """
1749 keyset_name = self.custom_name.get()
1750 delmsg = 'Are you sure you wish to delete the key set %r ?'
Terry Jan Reedy3457f422017-08-27 16:39:41 -04001751 if not self.askyesno(
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001752 'Delete Key Set', delmsg % keyset_name, parent=self):
1753 return
1754 self.cd.deactivate_current_config()
1755 # Remove key set from changes, config, and file.
1756 changes.delete_section('keys', keyset_name)
1757 # Reload user key set list.
1758 item_list = idleConf.GetSectionList('user', 'keys')
1759 item_list.sort()
1760 if not item_list:
Cheryl Sabella7028e592017-08-26 14:26:02 -04001761 self.custom_keyset_on.state(('disabled',))
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001762 self.customlist.SetMenu(item_list, '- no custom keys -')
1763 else:
1764 self.customlist.SetMenu(item_list, item_list[0])
1765 # Revert to default key set.
1766 self.keyset_source.set(idleConf.defaultCfg['main']
Tal Einat604e7b92018-09-25 15:10:14 +03001767 .Get('Keys', 'default'))
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001768 self.builtin_name.set(idleConf.defaultCfg['main'].Get('Keys', 'name')
Tal Einat604e7b92018-09-25 15:10:14 +03001769 or idleConf.default_keys())
Cheryl Sabellae36d9f52017-08-15 18:26:23 -04001770 # User can't back out of these changes, they must be applied now.
1771 changes.save_all()
1772 self.cd.save_all_changed_extensions()
1773 self.cd.activate_config_changes()
1774 self.set_keys_type()
1775
1776
csabellae8eb17b2017-07-30 18:39:17 -04001777class GenPage(Frame):
1778
csabella6f446be2017-08-01 00:24:07 -04001779 def __init__(self, master):
1780 super().__init__(master)
Tal Einat1ebee372019-07-23 13:02:11 +03001781
1782 self.init_validators()
csabellae8eb17b2017-07-30 18:39:17 -04001783 self.create_page_general()
1784 self.load_general_cfg()
1785
Tal Einat1ebee372019-07-23 13:02:11 +03001786 def init_validators(self):
1787 digits_or_empty_re = re.compile(r'[0-9]*')
1788 def is_digits_or_empty(s):
1789 "Return 's is blank or contains only digits'"
1790 return digits_or_empty_re.fullmatch(s) is not None
1791 self.digits_only = (self.register(is_digits_or_empty), '%P',)
1792
csabellae8eb17b2017-07-30 18:39:17 -04001793 def create_page_general(self):
1794 """Return frame of widgets for General tab.
1795
1796 Enable users to provisionally change general options. Function
1797 load_general_cfg intializes tk variables and helplist using
1798 idleConf. Radiobuttons startup_shell_on and startup_editor_on
1799 set var startup_edit. Radiobuttons save_ask_on and save_auto_on
1800 set var autosave. Entry boxes win_width_int and win_height_int
1801 set var win_width and win_height. Setting var_name invokes the
1802 default callback that adds option to changes.
1803
1804 Helplist: load_general_cfg loads list user_helplist with
1805 name, position pairs and copies names to listbox helplist.
1806 Clicking a name invokes help_source selected. Clicking
1807 button_helplist_name invokes helplist_item_name, which also
1808 changes user_helplist. These functions all call
1809 set_add_delete_state. All but load call update_help_changes to
1810 rewrite changes['main']['HelpFiles'].
1811
Cheryl Sabella2f896462017-08-14 21:21:43 -04001812 Widgets for GenPage(Frame): (*) widgets bound to self
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001813 frame_window: LabelFrame
1814 frame_run: Frame
1815 startup_title: Label
1816 (*)startup_editor_on: Radiobutton - startup_edit
1817 (*)startup_shell_on: Radiobutton - startup_edit
1818 frame_win_size: Frame
1819 win_size_title: Label
1820 win_width_title: Label
1821 (*)win_width_int: Entry - win_width
1822 win_height_title: Label
1823 (*)win_height_int: Entry - win_height
Cheryl Sabella845d8642018-02-04 18:15:21 -05001824 frame_autocomplete: Frame
1825 auto_wait_title: Label
1826 (*)auto_wait_int: Entry - autocomplete_wait
1827 frame_paren1: Frame
1828 paren_style_title: Label
1829 (*)paren_style_type: OptionMenu - paren_style
1830 frame_paren2: Frame
1831 paren_time_title: Label
1832 (*)paren_flash_time: Entry - flash_delay
1833 (*)bell_on: Checkbutton - paren_bell
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001834 frame_editor: LabelFrame
1835 frame_save: Frame
1836 run_save_title: Label
1837 (*)save_ask_on: Radiobutton - autosave
1838 (*)save_auto_on: Radiobutton - autosave
Cheryl Sabella845d8642018-02-04 18:15:21 -05001839 frame_format: Frame
1840 format_width_title: Label
1841 (*)format_width_int: Entry - format_width
Tal Einat7123ea02019-07-23 15:22:11 +03001842 frame_line_numbers_default: Frame
1843 line_numbers_default_title: Label
1844 (*)line_numbers_default_bool: Checkbutton - line_numbers_default
Cheryl Sabella845d8642018-02-04 18:15:21 -05001845 frame_context: Frame
1846 context_title: Label
1847 (*)context_int: Entry - context_lines
Tal Einat604e7b92018-09-25 15:10:14 +03001848 frame_shell: LabelFrame
1849 frame_auto_squeeze_min_lines: Frame
1850 auto_squeeze_min_lines_title: Label
1851 (*)auto_squeeze_min_lines_int: Entry - auto_squeeze_min_lines
Cheryl Sabella2f896462017-08-14 21:21:43 -04001852 frame_help: LabelFrame
1853 frame_helplist: Frame
1854 frame_helplist_buttons: Frame
1855 (*)button_helplist_edit
1856 (*)button_helplist_add
1857 (*)button_helplist_remove
1858 (*)helplist: ListBox
1859 scroll_helplist: Scrollbar
csabellae8eb17b2017-07-30 18:39:17 -04001860 """
wohlganger58fc71c2017-09-10 16:19:47 -05001861 # Integer values need StringVar because int('') raises.
csabellae8eb17b2017-07-30 18:39:17 -04001862 self.startup_edit = tracers.add(
1863 IntVar(self), ('main', 'General', 'editor-on-startup'))
csabellae8eb17b2017-07-30 18:39:17 -04001864 self.win_width = tracers.add(
1865 StringVar(self), ('main', 'EditorWindow', 'width'))
1866 self.win_height = tracers.add(
1867 StringVar(self), ('main', 'EditorWindow', 'height'))
wohlganger58fc71c2017-09-10 16:19:47 -05001868 self.autocomplete_wait = tracers.add(
1869 StringVar(self), ('extensions', 'AutoComplete', 'popupwait'))
1870 self.paren_style = tracers.add(
1871 StringVar(self), ('extensions', 'ParenMatch', 'style'))
1872 self.flash_delay = tracers.add(
1873 StringVar(self), ('extensions', 'ParenMatch', 'flash-delay'))
1874 self.paren_bell = tracers.add(
1875 BooleanVar(self), ('extensions', 'ParenMatch', 'bell'))
csabellae8eb17b2017-07-30 18:39:17 -04001876
Tal Einat604e7b92018-09-25 15:10:14 +03001877 self.auto_squeeze_min_lines = tracers.add(
1878 StringVar(self), ('main', 'PyShell', 'auto-squeeze-min-lines'))
1879
wohlganger58fc71c2017-09-10 16:19:47 -05001880 self.autosave = tracers.add(
1881 IntVar(self), ('main', 'General', 'autosave'))
1882 self.format_width = tracers.add(
1883 StringVar(self), ('extensions', 'FormatParagraph', 'max-width'))
Tal Einat7123ea02019-07-23 15:22:11 +03001884 self.line_numbers_default = tracers.add(
1885 BooleanVar(self),
1886 ('main', 'EditorWindow', 'line-numbers-default'))
wohlganger58fc71c2017-09-10 16:19:47 -05001887 self.context_lines = tracers.add(
Cheryl Sabella29996a12018-06-01 19:23:00 -04001888 StringVar(self), ('extensions', 'CodeContext', 'maxlines'))
wohlganger58fc71c2017-09-10 16:19:47 -05001889
1890 # Create widgets:
csabellae8eb17b2017-07-30 18:39:17 -04001891 # Section frames.
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001892 frame_window = LabelFrame(self, borderwidth=2, relief=GROOVE,
1893 text=' Window Preferences')
1894 frame_editor = LabelFrame(self, borderwidth=2, relief=GROOVE,
1895 text=' Editor Preferences')
Tal Einat604e7b92018-09-25 15:10:14 +03001896 frame_shell = LabelFrame(self, borderwidth=2, relief=GROOVE,
1897 text=' Shell Preferences')
csabellae8eb17b2017-07-30 18:39:17 -04001898 frame_help = LabelFrame(self, borderwidth=2, relief=GROOVE,
Tal Einat604e7b92018-09-25 15:10:14 +03001899 text=' Additional Help Sources ')
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001900 # Frame_window.
1901 frame_run = Frame(frame_window, borderwidth=0)
csabellae8eb17b2017-07-30 18:39:17 -04001902 startup_title = Label(frame_run, text='At Startup')
1903 self.startup_editor_on = Radiobutton(
1904 frame_run, variable=self.startup_edit, value=1,
1905 text="Open Edit Window")
1906 self.startup_shell_on = Radiobutton(
1907 frame_run, variable=self.startup_edit, value=0,
1908 text='Open Shell Window')
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001909
wohlganger58fc71c2017-09-10 16:19:47 -05001910 frame_win_size = Frame(frame_window, borderwidth=0)
csabellae8eb17b2017-07-30 18:39:17 -04001911 win_size_title = Label(
1912 frame_win_size, text='Initial Window Size (in characters)')
1913 win_width_title = Label(frame_win_size, text='Width')
1914 self.win_width_int = Entry(
Tal Einat1ebee372019-07-23 13:02:11 +03001915 frame_win_size, textvariable=self.win_width, width=3,
1916 validatecommand=self.digits_only, validate='key',
1917 )
csabellae8eb17b2017-07-30 18:39:17 -04001918 win_height_title = Label(frame_win_size, text='Height')
1919 self.win_height_int = Entry(
Tal Einat1ebee372019-07-23 13:02:11 +03001920 frame_win_size, textvariable=self.win_height, width=3,
1921 validatecommand=self.digits_only, validate='key',
1922 )
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001923
wohlganger58fc71c2017-09-10 16:19:47 -05001924 frame_autocomplete = Frame(frame_window, borderwidth=0,)
1925 auto_wait_title = Label(frame_autocomplete,
1926 text='Completions Popup Wait (milliseconds)')
1927 self.auto_wait_int = Entry(frame_autocomplete, width=6,
Tal Einat1ebee372019-07-23 13:02:11 +03001928 textvariable=self.autocomplete_wait,
1929 validatecommand=self.digits_only,
1930 validate='key',
1931 )
wohlganger58fc71c2017-09-10 16:19:47 -05001932
1933 frame_paren1 = Frame(frame_window, borderwidth=0)
1934 paren_style_title = Label(frame_paren1, text='Paren Match Style')
1935 self.paren_style_type = OptionMenu(
1936 frame_paren1, self.paren_style, 'expression',
1937 "opener","parens","expression")
1938 frame_paren2 = Frame(frame_window, borderwidth=0)
1939 paren_time_title = Label(
1940 frame_paren2, text='Time Match Displayed (milliseconds)\n'
1941 '(0 is until next input)')
1942 self.paren_flash_time = Entry(
1943 frame_paren2, textvariable=self.flash_delay, width=6)
1944 self.bell_on = Checkbutton(
1945 frame_paren2, text="Bell on Mismatch", variable=self.paren_bell)
1946
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04001947 # Frame_editor.
1948 frame_save = Frame(frame_editor, borderwidth=0)
1949 run_save_title = Label(frame_save, text='At Start of Run (F5) ')
1950 self.save_ask_on = Radiobutton(
1951 frame_save, variable=self.autosave, value=0,
1952 text="Prompt to Save")
1953 self.save_auto_on = Radiobutton(
1954 frame_save, variable=self.autosave, value=1,
1955 text='No Prompt')
1956
wohlganger58fc71c2017-09-10 16:19:47 -05001957 frame_format = Frame(frame_editor, borderwidth=0)
1958 format_width_title = Label(frame_format,
1959 text='Format Paragraph Max Width')
1960 self.format_width_int = Entry(
Tal Einat1ebee372019-07-23 13:02:11 +03001961 frame_format, textvariable=self.format_width, width=4,
1962 validatecommand=self.digits_only, validate='key',
1963 )
wohlganger58fc71c2017-09-10 16:19:47 -05001964
Tal Einat7123ea02019-07-23 15:22:11 +03001965 frame_line_numbers_default = Frame(frame_editor, borderwidth=0)
1966 line_numbers_default_title = Label(
1967 frame_line_numbers_default, text='Show line numbers in new windows')
1968 self.line_numbers_default_bool = Checkbutton(
1969 frame_line_numbers_default,
1970 variable=self.line_numbers_default,
1971 width=1)
1972
wohlganger58fc71c2017-09-10 16:19:47 -05001973 frame_context = Frame(frame_editor, borderwidth=0)
Cheryl Sabella29996a12018-06-01 19:23:00 -04001974 context_title = Label(frame_context, text='Max Context Lines :')
wohlganger58fc71c2017-09-10 16:19:47 -05001975 self.context_int = Entry(
Tal Einat1ebee372019-07-23 13:02:11 +03001976 frame_context, textvariable=self.context_lines, width=3,
1977 validatecommand=self.digits_only, validate='key',
1978 )
wohlganger58fc71c2017-09-10 16:19:47 -05001979
Tal Einat604e7b92018-09-25 15:10:14 +03001980 # Frame_shell.
1981 frame_auto_squeeze_min_lines = Frame(frame_shell, borderwidth=0)
1982 auto_squeeze_min_lines_title = Label(frame_auto_squeeze_min_lines,
1983 text='Auto-Squeeze Min. Lines:')
1984 self.auto_squeeze_min_lines_int = Entry(
Tal Einat1ebee372019-07-23 13:02:11 +03001985 frame_auto_squeeze_min_lines, width=4,
1986 textvariable=self.auto_squeeze_min_lines,
1987 validatecommand=self.digits_only, validate='key',
1988 )
wohlganger58fc71c2017-09-10 16:19:47 -05001989
csabellae8eb17b2017-07-30 18:39:17 -04001990 # frame_help.
1991 frame_helplist = Frame(frame_help)
1992 frame_helplist_buttons = Frame(frame_helplist)
1993 self.helplist = Listbox(
1994 frame_helplist, height=5, takefocus=True,
1995 exportselection=FALSE)
1996 scroll_helplist = Scrollbar(frame_helplist)
1997 scroll_helplist['command'] = self.helplist.yview
1998 self.helplist['yscrollcommand'] = scroll_helplist.set
1999 self.helplist.bind('<ButtonRelease-1>', self.help_source_selected)
2000 self.button_helplist_edit = Button(
Cheryl Sabella7028e592017-08-26 14:26:02 -04002001 frame_helplist_buttons, text='Edit', state='disabled',
csabellae8eb17b2017-07-30 18:39:17 -04002002 width=8, command=self.helplist_item_edit)
2003 self.button_helplist_add = Button(
2004 frame_helplist_buttons, text='Add',
2005 width=8, command=self.helplist_item_add)
2006 self.button_helplist_remove = Button(
Cheryl Sabella7028e592017-08-26 14:26:02 -04002007 frame_helplist_buttons, text='Remove', state='disabled',
csabellae8eb17b2017-07-30 18:39:17 -04002008 width=8, command=self.helplist_item_remove)
2009
2010 # Pack widgets:
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04002011 # Body.
2012 frame_window.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH)
2013 frame_editor.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH)
Tal Einat604e7b92018-09-25 15:10:14 +03002014 frame_shell.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH)
csabellae8eb17b2017-07-30 18:39:17 -04002015 frame_help.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH)
2016 # frame_run.
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04002017 frame_run.pack(side=TOP, padx=5, pady=0, fill=X)
csabellae8eb17b2017-07-30 18:39:17 -04002018 startup_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2019 self.startup_shell_on.pack(side=RIGHT, anchor=W, padx=5, pady=5)
2020 self.startup_editor_on.pack(side=RIGHT, anchor=W, padx=5, pady=5)
csabellae8eb17b2017-07-30 18:39:17 -04002021 # frame_win_size.
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04002022 frame_win_size.pack(side=TOP, padx=5, pady=0, fill=X)
csabellae8eb17b2017-07-30 18:39:17 -04002023 win_size_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2024 self.win_height_int.pack(side=RIGHT, anchor=E, padx=10, pady=5)
2025 win_height_title.pack(side=RIGHT, anchor=E, pady=5)
2026 self.win_width_int.pack(side=RIGHT, anchor=E, padx=10, pady=5)
2027 win_width_title.pack(side=RIGHT, anchor=E, pady=5)
wohlganger58fc71c2017-09-10 16:19:47 -05002028 # frame_autocomplete.
2029 frame_autocomplete.pack(side=TOP, padx=5, pady=0, fill=X)
2030 auto_wait_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2031 self.auto_wait_int.pack(side=TOP, padx=10, pady=5)
2032 # frame_paren.
2033 frame_paren1.pack(side=TOP, padx=5, pady=0, fill=X)
2034 paren_style_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2035 self.paren_style_type.pack(side=TOP, padx=10, pady=5)
2036 frame_paren2.pack(side=TOP, padx=5, pady=0, fill=X)
2037 paren_time_title.pack(side=LEFT, anchor=W, padx=5)
2038 self.bell_on.pack(side=RIGHT, anchor=E, padx=15, pady=5)
2039 self.paren_flash_time.pack(side=TOP, anchor=W, padx=15, pady=5)
2040
Terry Jan Reedy390eadd2017-08-30 00:59:11 -04002041 # frame_save.
2042 frame_save.pack(side=TOP, padx=5, pady=0, fill=X)
2043 run_save_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2044 self.save_auto_on.pack(side=RIGHT, anchor=W, padx=5, pady=5)
2045 self.save_ask_on.pack(side=RIGHT, anchor=W, padx=5, pady=5)
wohlganger58fc71c2017-09-10 16:19:47 -05002046 # frame_format.
2047 frame_format.pack(side=TOP, padx=5, pady=0, fill=X)
2048 format_width_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2049 self.format_width_int.pack(side=TOP, padx=10, pady=5)
Tal Einat7123ea02019-07-23 15:22:11 +03002050 # frame_line_numbers_default.
2051 frame_line_numbers_default.pack(side=TOP, padx=5, pady=0, fill=X)
2052 line_numbers_default_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2053 self.line_numbers_default_bool.pack(side=LEFT, padx=5, pady=5)
wohlganger58fc71c2017-09-10 16:19:47 -05002054 # frame_context.
2055 frame_context.pack(side=TOP, padx=5, pady=0, fill=X)
2056 context_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2057 self.context_int.pack(side=TOP, padx=5, pady=5)
2058
Tal Einat604e7b92018-09-25 15:10:14 +03002059 # frame_auto_squeeze_min_lines
2060 frame_auto_squeeze_min_lines.pack(side=TOP, padx=5, pady=0, fill=X)
2061 auto_squeeze_min_lines_title.pack(side=LEFT, anchor=W, padx=5, pady=5)
2062 self.auto_squeeze_min_lines_int.pack(side=TOP, padx=5, pady=5)
2063
csabellae8eb17b2017-07-30 18:39:17 -04002064 # frame_help.
2065 frame_helplist_buttons.pack(side=RIGHT, padx=5, pady=5, fill=Y)
2066 frame_helplist.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH)
2067 scroll_helplist.pack(side=RIGHT, anchor=W, fill=Y)
2068 self.helplist.pack(side=LEFT, anchor=E, expand=TRUE, fill=BOTH)
2069 self.button_helplist_edit.pack(side=TOP, anchor=W, pady=5)
2070 self.button_helplist_add.pack(side=TOP, anchor=W)
2071 self.button_helplist_remove.pack(side=TOP, anchor=W, pady=5)
2072
2073 def load_general_cfg(self):
2074 "Load current configuration settings for the general options."
wohlganger58fc71c2017-09-10 16:19:47 -05002075 # Set variables for all windows.
csabellae8eb17b2017-07-30 18:39:17 -04002076 self.startup_edit.set(idleConf.GetOption(
wohlganger58fc71c2017-09-10 16:19:47 -05002077 'main', 'General', 'editor-on-startup', type='bool'))
csabellae8eb17b2017-07-30 18:39:17 -04002078 self.win_width.set(idleConf.GetOption(
2079 'main', 'EditorWindow', 'width', type='int'))
2080 self.win_height.set(idleConf.GetOption(
2081 'main', 'EditorWindow', 'height', type='int'))
wohlganger58fc71c2017-09-10 16:19:47 -05002082 self.autocomplete_wait.set(idleConf.GetOption(
2083 'extensions', 'AutoComplete', 'popupwait', type='int'))
2084 self.paren_style.set(idleConf.GetOption(
2085 'extensions', 'ParenMatch', 'style'))
2086 self.flash_delay.set(idleConf.GetOption(
2087 'extensions', 'ParenMatch', 'flash-delay', type='int'))
2088 self.paren_bell.set(idleConf.GetOption(
2089 'extensions', 'ParenMatch', 'bell'))
2090
2091 # Set variables for editor windows.
2092 self.autosave.set(idleConf.GetOption(
2093 'main', 'General', 'autosave', default=0, type='bool'))
2094 self.format_width.set(idleConf.GetOption(
2095 'extensions', 'FormatParagraph', 'max-width', type='int'))
Tal Einat7123ea02019-07-23 15:22:11 +03002096 self.line_numbers_default.set(idleConf.GetOption(
2097 'main', 'EditorWindow', 'line-numbers-default', type='bool'))
wohlganger58fc71c2017-09-10 16:19:47 -05002098 self.context_lines.set(idleConf.GetOption(
Cheryl Sabella29996a12018-06-01 19:23:00 -04002099 'extensions', 'CodeContext', 'maxlines', type='int'))
wohlganger58fc71c2017-09-10 16:19:47 -05002100
Tal Einat604e7b92018-09-25 15:10:14 +03002101 # Set variables for shell windows.
2102 self.auto_squeeze_min_lines.set(idleConf.GetOption(
2103 'main', 'PyShell', 'auto-squeeze-min-lines', type='int'))
2104
csabellae8eb17b2017-07-30 18:39:17 -04002105 # Set additional help sources.
2106 self.user_helplist = idleConf.GetAllExtraHelpSourcesList()
2107 self.helplist.delete(0, 'end')
2108 for help_item in self.user_helplist:
2109 self.helplist.insert(END, help_item[0])
2110 self.set_add_delete_state()
2111
2112 def help_source_selected(self, event):
2113 "Handle event for selecting additional help."
2114 self.set_add_delete_state()
2115
2116 def set_add_delete_state(self):
2117 "Toggle the state for the help list buttons based on list entries."
2118 if self.helplist.size() < 1: # No entries in list.
Cheryl Sabella7028e592017-08-26 14:26:02 -04002119 self.button_helplist_edit.state(('disabled',))
2120 self.button_helplist_remove.state(('disabled',))
csabellae8eb17b2017-07-30 18:39:17 -04002121 else: # Some entries.
2122 if self.helplist.curselection(): # There currently is a selection.
Cheryl Sabella7028e592017-08-26 14:26:02 -04002123 self.button_helplist_edit.state(('!disabled',))
2124 self.button_helplist_remove.state(('!disabled',))
csabellae8eb17b2017-07-30 18:39:17 -04002125 else: # There currently is not a selection.
Cheryl Sabella7028e592017-08-26 14:26:02 -04002126 self.button_helplist_edit.state(('disabled',))
2127 self.button_helplist_remove.state(('disabled',))
csabellae8eb17b2017-07-30 18:39:17 -04002128
2129 def helplist_item_add(self):
2130 """Handle add button for the help list.
2131
2132 Query for name and location of new help sources and add
2133 them to the list.
2134 """
2135 help_source = HelpSource(self, 'New Help Source').result
2136 if help_source:
2137 self.user_helplist.append(help_source)
2138 self.helplist.insert(END, help_source[0])
2139 self.update_help_changes()
2140
2141 def helplist_item_edit(self):
2142 """Handle edit button for the help list.
2143
2144 Query with existing help source information and update
2145 config if the values are changed.
2146 """
2147 item_index = self.helplist.index(ANCHOR)
2148 help_source = self.user_helplist[item_index]
2149 new_help_source = HelpSource(
2150 self, 'Edit Help Source',
2151 menuitem=help_source[0],
2152 filepath=help_source[1],
2153 ).result
2154 if new_help_source and new_help_source != help_source:
2155 self.user_helplist[item_index] = new_help_source
2156 self.helplist.delete(item_index)
2157 self.helplist.insert(item_index, new_help_source[0])
2158 self.update_help_changes()
2159 self.set_add_delete_state() # Selected will be un-selected
2160
2161 def helplist_item_remove(self):
2162 """Handle remove button for the help list.
2163
2164 Delete the help list item from config.
2165 """
2166 item_index = self.helplist.index(ANCHOR)
2167 del(self.user_helplist[item_index])
2168 self.helplist.delete(item_index)
2169 self.update_help_changes()
2170 self.set_add_delete_state()
2171
2172 def update_help_changes(self):
2173 "Clear and rebuild the HelpFiles section in changes"
2174 changes['main']['HelpFiles'] = {}
2175 for num in range(1, len(self.user_helplist) + 1):
2176 changes.add_option(
2177 'main', 'HelpFiles', str(num),
2178 ';'.join(self.user_helplist[num-1][:2]))
2179
2180
csabella45bf7232017-07-26 19:09:58 -04002181class VarTrace:
2182 """Maintain Tk variables trace state."""
2183
2184 def __init__(self):
2185 """Store Tk variables and callbacks.
2186
2187 untraced: List of tuples (var, callback)
2188 that do not have the callback attached
2189 to the Tk var.
2190 traced: List of tuples (var, callback) where
2191 that callback has been attached to the var.
2192 """
2193 self.untraced = []
2194 self.traced = []
2195
Terry Jan Reedy5d0f30a2017-07-28 17:00:02 -04002196 def clear(self):
2197 "Clear lists (for tests)."
Terry Jan Reedy733d0f62017-08-07 14:22:44 -04002198 # Call after all tests in a module to avoid memory leaks.
Terry Jan Reedy5d0f30a2017-07-28 17:00:02 -04002199 self.untraced.clear()
2200 self.traced.clear()
2201
csabella45bf7232017-07-26 19:09:58 -04002202 def add(self, var, callback):
2203 """Add (var, callback) tuple to untraced list.
2204
2205 Args:
2206 var: Tk variable instance.
csabella5b591542017-07-28 14:40:59 -04002207 callback: Either function name to be used as a callback
2208 or a tuple with IdleConf config-type, section, and
2209 option names used in the default callback.
csabella45bf7232017-07-26 19:09:58 -04002210
2211 Return:
2212 Tk variable instance.
2213 """
2214 if isinstance(callback, tuple):
2215 callback = self.make_callback(var, callback)
2216 self.untraced.append((var, callback))
2217 return var
2218
2219 @staticmethod
2220 def make_callback(var, config):
2221 "Return default callback function to add values to changes instance."
2222 def default_callback(*params):
2223 "Add config values to changes instance."
2224 changes.add_option(*config, var.get())
2225 return default_callback
2226
2227 def attach(self):
2228 "Attach callback to all vars that are not traced."
2229 while self.untraced:
2230 var, callback = self.untraced.pop()
2231 var.trace_add('write', callback)
2232 self.traced.append((var, callback))
2233
2234 def detach(self):
2235 "Remove callback from traced vars."
2236 while self.traced:
2237 var, callback = self.traced.pop()
2238 var.trace_remove('write', var.trace_info()[0][1])
2239 self.untraced.append((var, callback))
2240
2241
csabella5b591542017-07-28 14:40:59 -04002242tracers = VarTrace()
2243
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -04002244help_common = '''\
2245When you click either the Apply or Ok buttons, settings in this
2246dialog that are different from IDLE's default are saved in
2247a .idlerc directory in your home directory. Except as noted,
Terry Jan Reedyd0c0f002015-11-12 15:02:57 -05002248these changes apply to all versions of IDLE installed on this
Terry Jan Reedye2e42272017-10-17 18:56:16 -04002249machine. [Cancel] only cancels changes made since the last save.
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -04002250'''
2251help_pages = {
Terry Jan Reedye2e42272017-10-17 18:56:16 -04002252 'Fonts/Tabs':'''
2253Font sample: This shows what a selection of Basic Multilingual Plane
2254unicode characters look like for the current font selection. If the
2255selected font does not define a character, Tk attempts to find another
2256font that does. Substitute glyphs depend on what is available on a
2257particular system and will not necessarily have the same size as the
2258font selected. Line contains 20 characters up to Devanagari, 14 for
2259Tamil, and 10 for East Asia.
2260
2261Hebrew and Arabic letters should display right to left, starting with
2262alef, \u05d0 and \u0627. Arabic digits display left to right. The
2263Devanagari and Tamil lines start with digits. The East Asian lines
2264are Chinese digits, Chinese Hanzi, Korean Hangul, and Japanese
2265Hiragana and Katakana.
Serhiy Storchakaed6554c2017-10-28 03:22:44 +03002266
2267You can edit the font sample. Changes remain until IDLE is closed.
Terry Jan Reedye2e42272017-10-17 18:56:16 -04002268''',
Cheryl Sabella3866d9b2017-09-10 22:41:10 -04002269 'Highlights': '''
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -04002270Highlighting:
Terry Jan Reedyd0c0f002015-11-12 15:02:57 -05002271The IDLE Dark color theme is new in October 2015. It can only
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -04002272be used with older IDLE releases if it is saved as a custom
2273theme, with a different name.
Terry Jan Reedy9bdb1ed2016-07-10 13:46:34 -04002274''',
2275 'Keys': '''
2276Keys:
2277The IDLE Modern Unix key set is new in June 2016. It can only
2278be used with older IDLE releases if it is saved as a custom
2279key set, with a different name.
2280''',
wohlganger58fc71c2017-09-10 16:19:47 -05002281 'General': '''
2282General:
wohlgangerfae2c352017-06-27 21:36:23 -05002283
penguindustin96466302019-05-06 14:57:17 -04002284AutoComplete: Popupwait is milliseconds to wait after key char, without
wohlgangerfae2c352017-06-27 21:36:23 -05002285cursor movement, before popping up completion box. Key char is '.' after
2286identifier or a '/' (or '\\' on Windows) within a string.
2287
2288FormatParagraph: Max-width is max chars in lines after re-formatting.
2289Use with paragraphs in both strings and comment blocks.
2290
2291ParenMatch: Style indicates what is highlighted when closer is entered:
2292'opener' - opener '({[' corresponding to closer; 'parens' - both chars;
2293'expression' (default) - also everything in between. Flash-delay is how
2294long to highlight if cursor is not moved (0 means forever).
Cheryl Sabella29996a12018-06-01 19:23:00 -04002295
2296CodeContext: Maxlines is the maximum number of code context lines to
2297display when Code Context is turned on for an editor window.
Tal Einat604e7b92018-09-25 15:10:14 +03002298
2299Shell Preferences: Auto-Squeeze Min. Lines is the minimum number of lines
2300of output to automatically "squeeze".
wohlgangerfae2c352017-06-27 21:36:23 -05002301'''
Terry Jan Reedyd0cadba2015-10-11 22:07:31 -04002302}
2303
Steven M. Gavac11ccf32001-09-24 09:43:17 +00002304
Terry Jan Reedy93f35422015-10-13 22:03:51 -04002305def is_int(s):
2306 "Return 's is blank or represents an int'"
2307 if not s:
2308 return True
2309 try:
2310 int(s)
2311 return True
2312 except ValueError:
2313 return False
2314
2315
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002316class VerticalScrolledFrame(Frame):
2317 """A pure Tkinter vertically scrollable frame.
2318
2319 * Use the 'interior' attribute to place widgets inside the scrollable frame
2320 * Construct and pack/place/grid normally
2321 * This frame only allows vertical scrolling
2322 """
2323 def __init__(self, parent, *args, **kw):
2324 Frame.__init__(self, parent, *args, **kw)
2325
csabella7eb58832017-07-04 21:30:58 -04002326 # Create a canvas object and a vertical scrollbar for scrolling it.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002327 vscrollbar = Scrollbar(self, orient=VERTICAL)
2328 vscrollbar.pack(fill=Y, side=RIGHT, expand=FALSE)
Cheryl Sabella7028e592017-08-26 14:26:02 -04002329 canvas = Canvas(self, borderwidth=0, highlightthickness=0,
Terry Jan Reedyd0812292015-10-22 03:27:31 -04002330 yscrollcommand=vscrollbar.set, width=240)
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002331 canvas.pack(side=LEFT, fill=BOTH, expand=TRUE)
2332 vscrollbar.config(command=canvas.yview)
2333
csabella7eb58832017-07-04 21:30:58 -04002334 # Reset the view.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002335 canvas.xview_moveto(0)
2336 canvas.yview_moveto(0)
2337
csabella7eb58832017-07-04 21:30:58 -04002338 # Create a frame inside the canvas which will be scrolled with it.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002339 self.interior = interior = Frame(canvas)
2340 interior_id = canvas.create_window(0, 0, window=interior, anchor=NW)
2341
csabella7eb58832017-07-04 21:30:58 -04002342 # Track changes to the canvas and frame width and sync them,
2343 # also updating the scrollbar.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002344 def _configure_interior(event):
csabella7eb58832017-07-04 21:30:58 -04002345 # Update the scrollbars to match the size of the inner frame.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002346 size = (interior.winfo_reqwidth(), interior.winfo_reqheight())
2347 canvas.config(scrollregion="0 0 %s %s" % size)
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002348 interior.bind('<Configure>', _configure_interior)
2349
2350 def _configure_canvas(event):
2351 if interior.winfo_reqwidth() != canvas.winfo_width():
csabella7eb58832017-07-04 21:30:58 -04002352 # Update the inner frame's width to fill the canvas.
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002353 canvas.itemconfigure(interior_id, width=canvas.winfo_width())
2354 canvas.bind('<Configure>', _configure_canvas)
2355
2356 return
2357
Terry Jan Reedya9421fb2014-10-22 20:15:18 -04002358
Steven M. Gava44d3d1a2001-07-31 06:59:02 +00002359if __name__ == '__main__':
Terry Jan Reedy4d921582018-06-19 19:12:52 -04002360 from unittest import main
2361 main('idlelib.idle_test.test_configdialog', verbosity=2, exit=False)
2362
Terry Jan Reedy2e8234a2014-05-29 01:46:26 -04002363 from idlelib.idle_test.htest import run
Terry Jan Reedy47304c02015-10-20 02:15:28 -04002364 run(ConfigDialog)