Terry Jan Reedy | c5507c0 | 2013-08-18 18:22:43 -0400 | [diff] [blame] | 1 | '''Define SearchDialogBase used by Search, Replace, and Grep dialogs.''' |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 2 | |
Terry Jan Reedy | aff0ada | 2019-01-02 22:04:06 -0500 | [diff] [blame] | 3 | from tkinter import Toplevel |
| 4 | from tkinter.ttk import Frame, Entry, Label, Button, Checkbutton, Radiobutton |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 5 | |
Terry Jan Reedy | bfbaa6b | 2016-08-31 00:50:55 -0400 | [diff] [blame] | 6 | |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 7 | class SearchDialogBase: |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 8 | '''Create most of a 3 or 4 row, 3 column search dialog. |
Terry Jan Reedy | c5507c0 | 2013-08-18 18:22:43 -0400 | [diff] [blame] | 9 | |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 10 | The left and wide middle column contain: |
| 11 | 1 or 2 labeled text entry lines (make_entry, create_entries); |
| 12 | a row of standard Checkbuttons (make_frame, create_option_buttons), |
| 13 | each of which corresponds to a search engine Variable; |
| 14 | a row of dialog-specific Check/Radiobuttons (create_other_buttons). |
Terry Jan Reedy | ba5d8f3 | 2013-08-18 18:27:02 -0400 | [diff] [blame] | 15 | |
Terry Jan Reedy | c5507c0 | 2013-08-18 18:22:43 -0400 | [diff] [blame] | 16 | The narrow right column contains command buttons |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 17 | (make_button, create_command_buttons). |
Terry Jan Reedy | c5507c0 | 2013-08-18 18:22:43 -0400 | [diff] [blame] | 18 | These are bound to functions that execute the command. |
| 19 | |
Terry Jan Reedy | 525168b | 2014-06-30 20:00:03 -0400 | [diff] [blame] | 20 | Except for command buttons, this base class is not limited to items |
| 21 | common to all three subclasses. Rather, it is the Find dialog minus |
| 22 | the "Find Next" command, its execution function, and the |
| 23 | default_command attribute needed in create_widgets. The other |
| 24 | dialogs override attributes and methods, the latter to replace and |
| 25 | add widgets. |
Terry Jan Reedy | c5507c0 | 2013-08-18 18:22:43 -0400 | [diff] [blame] | 26 | ''' |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 27 | |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 28 | title = "Search Dialog" # replace in subclasses |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 29 | icon = "Search" |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 30 | needwrapbutton = 1 # not in Find in Files |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 31 | |
| 32 | def __init__(self, root, engine): |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 33 | '''Initialize root, engine, and top attributes. |
| 34 | |
| 35 | top (level widget): set in create_widgets() called from open(). |
Terry Jan Reedy | 525168b | 2014-06-30 20:00:03 -0400 | [diff] [blame] | 36 | text (Text searched): set in open(), only used in subclasses(). |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 37 | ent (ry): created in make_entry() called from create_entry(). |
| 38 | row (of grid): 0 in create_widgets(), +1 in make_entry/frame(). |
Xtreak | d9677f3 | 2019-06-03 09:51:15 +0530 | [diff] [blame] | 39 | default_command: set in subclasses, used in create_widgets(). |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 40 | |
| 41 | title (of dialog): class attribute, override in subclasses. |
| 42 | icon (of dialog): ditto, use unclear if cannot minimize dialog. |
| 43 | ''' |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 44 | self.root = root |
Terry Jan Reedy | c465682 | 2018-12-28 02:41:35 -0500 | [diff] [blame] | 45 | self.bell = root.bell |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 46 | self.engine = engine |
| 47 | self.top = None |
| 48 | |
Chui Tey | 5a231c8f | 2002-11-06 02:18:45 +0000 | [diff] [blame] | 49 | def open(self, text, searchphrase=None): |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 50 | "Make dialog visible on top of others and ready to use." |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 51 | self.text = text |
| 52 | if not self.top: |
| 53 | self.create_widgets() |
| 54 | else: |
| 55 | self.top.deiconify() |
| 56 | self.top.tkraise() |
Miss Islington (bot) | 295fe32 | 2019-06-06 23:17:13 -0700 | [diff] [blame] | 57 | self.top.transient(text.winfo_toplevel()) |
Chui Tey | 5a231c8f | 2002-11-06 02:18:45 +0000 | [diff] [blame] | 58 | if searchphrase: |
| 59 | self.ent.delete(0,"end") |
| 60 | self.ent.insert("end",searchphrase) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 61 | self.ent.focus_set() |
| 62 | self.ent.selection_range(0, "end") |
| 63 | self.ent.icursor(0) |
| 64 | self.top.grab_set() |
| 65 | |
| 66 | def close(self, event=None): |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 67 | "Put dialog away for later use." |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 68 | if self.top: |
| 69 | self.top.grab_release() |
Miss Islington (bot) | 295fe32 | 2019-06-06 23:17:13 -0700 | [diff] [blame] | 70 | self.top.transient('') |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 71 | self.top.withdraw() |
| 72 | |
| 73 | def create_widgets(self): |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 74 | '''Create basic 3 row x 3 col search (find) dialog. |
| 75 | |
| 76 | Other dialogs override subsidiary create_x methods as needed. |
| 77 | Replace and Find-in-Files add another entry row. |
| 78 | ''' |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 79 | top = Toplevel(self.root) |
| 80 | top.bind("<Return>", self.default_command) |
| 81 | top.bind("<Escape>", self.close) |
| 82 | top.protocol("WM_DELETE_WINDOW", self.close) |
| 83 | top.wm_title(self.title) |
| 84 | top.wm_iconname(self.icon) |
| 85 | self.top = top |
| 86 | |
| 87 | self.row = 0 |
Chui Tey | 72a8a3b | 2002-11-04 23:07:51 +0000 | [diff] [blame] | 88 | self.top.grid_columnconfigure(0, pad=2, weight=0) |
| 89 | self.top.grid_columnconfigure(1, pad=2, minsize=100, weight=100) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 90 | |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 91 | self.create_entries() # row 0 (and maybe 1), cols 0, 1 |
| 92 | self.create_option_buttons() # next row, cols 0, 1 |
| 93 | self.create_other_buttons() # next row, cols 0, 1 |
| 94 | self.create_command_buttons() # col 2, all rows |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 95 | |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 96 | def make_entry(self, label_text, var): |
| 97 | '''Return (entry, label), . |
| 98 | |
| 99 | entry - gridded labeled Entry for text entry. |
| 100 | label - Label widget, returned for testing. |
| 101 | ''' |
| 102 | label = Label(self.top, text=label_text) |
| 103 | label.grid(row=self.row, column=0, sticky="nw") |
| 104 | entry = Entry(self.top, textvariable=var, exportselection=0) |
| 105 | entry.grid(row=self.row, column=1, sticky="nwe") |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 106 | self.row = self.row + 1 |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 107 | return entry, label |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 108 | |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 109 | def create_entries(self): |
| 110 | "Create one or more entry lines with make_entry." |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 111 | self.ent = self.make_entry("Find:", self.engine.patvar)[0] |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 112 | |
Chui Tey | 72a8a3b | 2002-11-04 23:07:51 +0000 | [diff] [blame] | 113 | def make_frame(self,labeltext=None): |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 114 | '''Return (frame, label). |
| 115 | |
| 116 | frame - gridded labeled Frame for option or other buttons. |
| 117 | label - Label widget, returned for testing. |
| 118 | ''' |
Chui Tey | 72a8a3b | 2002-11-04 23:07:51 +0000 | [diff] [blame] | 119 | if labeltext: |
Terry Jan Reedy | 8cefd08 | 2014-06-30 23:52:20 -0400 | [diff] [blame] | 120 | label = Label(self.top, text=labeltext) |
| 121 | label.grid(row=self.row, column=0, sticky="nw") |
Terry Jan Reedy | 525168b | 2014-06-30 20:00:03 -0400 | [diff] [blame] | 122 | else: |
Terry Jan Reedy | 8cefd08 | 2014-06-30 23:52:20 -0400 | [diff] [blame] | 123 | label = '' |
| 124 | frame = Frame(self.top) |
| 125 | frame.grid(row=self.row, column=1, columnspan=1, sticky="nwe") |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 126 | self.row = self.row + 1 |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 127 | return frame, label |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 128 | |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 129 | def create_option_buttons(self): |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 130 | '''Return (filled frame, options) for testing. |
| 131 | |
Terry Jan Reedy | 6fa5bdc | 2016-05-28 13:22:31 -0400 | [diff] [blame] | 132 | Options is a list of searchengine booleanvar, label pairs. |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 133 | A gridded frame from make_frame is filled with a Checkbutton |
| 134 | for each pair, bound to the var, with the corresponding label. |
| 135 | ''' |
Terry Jan Reedy | 8cefd08 | 2014-06-30 23:52:20 -0400 | [diff] [blame] | 136 | frame = self.make_frame("Options")[0] |
| 137 | engine = self.engine |
| 138 | options = [(engine.revar, "Regular expression"), |
| 139 | (engine.casevar, "Match case"), |
| 140 | (engine.wordvar, "Whole word")] |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 141 | if self.needwrapbutton: |
Terry Jan Reedy | 8cefd08 | 2014-06-30 23:52:20 -0400 | [diff] [blame] | 142 | options.append((engine.wrapvar, "Wrap around")) |
| 143 | for var, label in options: |
Terry Jan Reedy | 6f7b0f5 | 2016-07-10 20:21:31 -0400 | [diff] [blame] | 144 | btn = Checkbutton(frame, variable=var, text=label) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 145 | btn.pack(side="left", fill="both") |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 146 | return frame, options |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 147 | |
| 148 | def create_other_buttons(self): |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 149 | '''Return (frame, others) for testing. |
| 150 | |
| 151 | Others is a list of value, label pairs. |
| 152 | A gridded frame from make_frame is filled with radio buttons. |
| 153 | ''' |
Terry Jan Reedy | 8cefd08 | 2014-06-30 23:52:20 -0400 | [diff] [blame] | 154 | frame = self.make_frame("Direction")[0] |
| 155 | var = self.engine.backvar |
| 156 | others = [(1, 'Up'), (0, 'Down')] |
| 157 | for val, label in others: |
Terry Jan Reedy | 6f7b0f5 | 2016-07-10 20:21:31 -0400 | [diff] [blame] | 158 | btn = Radiobutton(frame, variable=var, value=val, text=label) |
Terry Jan Reedy | 8cefd08 | 2014-06-30 23:52:20 -0400 | [diff] [blame] | 159 | btn.pack(side="left", fill="both") |
Terry Jan Reedy | 5283c4e | 2014-07-13 17:27:26 -0400 | [diff] [blame] | 160 | return frame, others |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 161 | |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 162 | def make_button(self, label, command, isdef=0): |
| 163 | "Return command button gridded in command frame." |
| 164 | b = Button(self.buttonframe, |
| 165 | text=label, command=command, |
| 166 | default=isdef and "active" or "normal") |
| 167 | cols,rows=self.buttonframe.grid_size() |
| 168 | b.grid(pady=1,row=rows,column=0,sticky="ew") |
| 169 | self.buttonframe.grid(rowspan=rows+1) |
| 170 | return b |
| 171 | |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 172 | def create_command_buttons(self): |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 173 | "Place buttons in vertical command frame gridded on right." |
Chui Tey | 72a8a3b | 2002-11-04 23:07:51 +0000 | [diff] [blame] | 174 | f = self.buttonframe = Frame(self.top) |
Kurt B. Kaiser | 4fc9047 | 2002-11-21 03:02:17 +0000 | [diff] [blame] | 175 | f.grid(row=0,column=2,padx=2,pady=2,ipadx=2,ipady=2) |
Chui Tey | 72a8a3b | 2002-11-04 23:07:51 +0000 | [diff] [blame] | 176 | |
Terry Jan Reedy | ba04302 | 2019-05-31 04:26:35 -0400 | [diff] [blame] | 177 | b = self.make_button("Close", self.close) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 178 | b.lower() |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 179 | |
Terry Jan Reedy | 6f7b0f5 | 2016-07-10 20:21:31 -0400 | [diff] [blame] | 180 | |
| 181 | class _searchbase(SearchDialogBase): # htest # |
| 182 | "Create auto-opening dialog with no text connection." |
| 183 | |
| 184 | def __init__(self, parent): |
| 185 | import re |
| 186 | from idlelib import searchengine |
| 187 | |
| 188 | self.root = parent |
| 189 | self.engine = searchengine.get(parent) |
| 190 | self.create_widgets() |
| 191 | print(parent.geometry()) |
| 192 | width,height, x,y = list(map(int, re.split('[x+]', parent.geometry()))) |
| 193 | self.top.geometry("+%d+%d" % (x + 40, y + 175)) |
| 194 | |
Terry Jan Reedy | 3ff55a8 | 2016-08-10 23:44:54 -0400 | [diff] [blame] | 195 | def default_command(self, dummy): pass |
Terry Jan Reedy | 6f7b0f5 | 2016-07-10 20:21:31 -0400 | [diff] [blame] | 196 | |
Terry Jan Reedy | 4d92158 | 2018-06-19 19:12:52 -0400 | [diff] [blame] | 197 | |
Terry Jan Reedy | ede0573 | 2014-06-26 01:40:51 -0400 | [diff] [blame] | 198 | if __name__ == '__main__': |
Terry Jan Reedy | 4d92158 | 2018-06-19 19:12:52 -0400 | [diff] [blame] | 199 | from unittest import main |
| 200 | main('idlelib.idle_test.test_searchbase', verbosity=2, exit=False) |
Terry Jan Reedy | 6f7b0f5 | 2016-07-10 20:21:31 -0400 | [diff] [blame] | 201 | |
| 202 | from idlelib.idle_test.htest import run |
| 203 | run(_searchbase) |