| Conditions | 220 |
| Total Lines | 681 |
| Code Lines | 539 |
| Lines | 110 |
| Ratio | 16.15 % |
| Tests | 0 |
| CRAP Score | 48620 |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like doorstop.gui.main.Application.init_main_frame() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
| 1 | #!/usr/bin/env python |
||
| 217 | @staticmethod |
||
| 218 | def init_main_frame(root: tk.Frame, store: Store) -> ttk.Frame: |
||
| 219 | """Initialize and return the main frame.""" |
||
| 220 | # Shared arguments |
||
| 221 | width_text = 30 |
||
| 222 | width_uid = 10 |
||
| 223 | height_text = 10 |
||
| 224 | height_ext = 5 |
||
| 225 | |||
| 226 | # Shared keyword arguments |
||
| 227 | kw_f = {'padding': 5} # constructor arguments for frames |
||
| 228 | kw_gp = {'padx': 2, 'pady': 2} # grid arguments for padded widgets |
||
| 229 | kw_gs = {'sticky': tk.NSEW} # grid arguments for sticky widgets |
||
| 230 | kw_gsp = dict(chain(kw_gs.items(), kw_gp.items())) # grid arguments for sticky padded widgets |
||
| 231 | |||
| 232 | # Configure grid |
||
| 233 | result_frame = ttk.Frame(root, **kw_f) |
||
| 234 | result_frame.rowconfigure(0, weight=0) |
||
| 235 | result_frame.columnconfigure(0, weight=1) |
||
| 236 | result_frame.columnconfigure(1, weight=1) |
||
| 237 | result_frame.columnconfigure(2, weight=1) |
||
| 238 | |||
| 239 | def frame_document(root) -> ttk.Frame: |
||
| 240 | """Frame for current document's outline.""" |
||
| 241 | # Configure grid |
||
| 242 | frame = ttk.Frame(root, **kw_f) |
||
| 243 | frame.rowconfigure(0, weight=0) # Label |
||
| 244 | frame.rowconfigure(1, weight=0) # Combobox |
||
| 245 | frame.rowconfigure(2, weight=1) # TreeView |
||
| 246 | frame.rowconfigure(3, weight=0) # Button |
||
| 247 | frame.columnconfigure(0, weight=0) # Slider |
||
| 248 | frame.columnconfigure(1, weight=1) |
||
| 249 | frame.columnconfigure(2, weight=1) |
||
| 250 | frame.columnconfigure(3, weight=1) |
||
| 251 | frame.columnconfigure(4, weight=1) |
||
| 252 | frame.columnconfigure(5, weight=1) |
||
| 253 | frame.columnconfigure(6, weight=1) |
||
| 254 | |||
| 255 | @_log |
||
| 256 | def treeview_outline_treeviewselect(event): |
||
| 257 | """Handle selecting an item in the tree view.""" |
||
| 258 | store.dispatch(Action_ChangeSelectedItem(event.widget.selection())) |
||
| 259 | |||
| 260 | # Place widgets |
||
| 261 | widget.Label(frame, text="Document:").grid(row=0, column=0, columnspan=7, sticky=tk.W, **kw_gp) |
||
| 262 | |||
| 263 | combobox_documents = widget.Combobox(frame, state="readonly") |
||
| 264 | combobox_documents.grid(row=1, column=0, columnspan=7, **kw_gsp) |
||
| 265 | |||
| 266 | # Display the information |
||
| 267 | def refreshDocumentComboboxContent(store: Optional[Store]) -> None: |
||
| 268 | state = None |
||
| 269 | project_tree = None |
||
| 270 | if store: |
||
| 271 | state = store.state |
||
| 272 | if state is not None: |
||
| 273 | project_tree = state.project_tree |
||
| 274 | documents = [document for document in project_tree] if project_tree else [] |
||
| 275 | combobox_documents['values'] = ["{} ({})".format(document.prefix, document.relpath) for document in documents] |
||
| 276 | |||
| 277 | def handle_document_combobox_selectionchange(*event: Any) -> None: |
||
| 278 | if store: |
||
| 279 | store.dispatch(Action_ChangeSelectedDocument(documents[combobox_documents.current()].prefix)) |
||
| 280 | combobox_documents.bind("<<ComboboxSelected>>", handle_document_combobox_selectionchange) |
||
| 281 | |||
| 282 | # Set the document Selection |
||
| 283 | selected_document_prefix = state.session_selected_document if state else None |
||
| 284 | for index, item in enumerate(documents): |
||
| 285 | if selected_document_prefix == item.prefix: |
||
| 286 | combobox_documents.current(index) |
||
| 287 | break |
||
| 288 | else: |
||
| 289 | combobox_documents.set("") |
||
| 290 | |||
| 291 | store.add_observer(lambda store: refreshDocumentComboboxContent(store)) |
||
| 292 | |||
| 293 | c_columnId = ("Id", "Text Preview") |
||
| 294 | treeview_outline = widget.TreeView(frame, columns=c_columnId) # pylint: disable=W0201 |
||
| 295 | treeview_outline.heading("#0", text="Level") |
||
| 296 | for col in c_columnId: |
||
| 297 | treeview_outline.heading(col, text=col) |
||
| 298 | treeview_outline.column("#0", minwidth=80, stretch=tk.NO) |
||
| 299 | treeview_outline.column("Id", minwidth=120, stretch=tk.NO) |
||
| 300 | treeview_outline.column("Text Preview", minwidth=50, stretch=tk.YES) |
||
| 301 | |||
| 302 | def refresh_document_outline(store: Optional[Store]) -> None: # Refresh the document outline |
||
| 303 | state = store.state if store else None |
||
| 304 | |||
| 305 | # Record the currently opened items. |
||
| 306 | c_openItem = [] |
||
| 307 | for c_currUID in utilTkinter.getAllChildren(treeview_outline): |
||
| 308 | if treeview_outline.item(c_currUID)["open"]: |
||
| 309 | c_openItem.append(c_currUID) |
||
| 310 | |||
| 311 | # Clear the widgets |
||
| 312 | treeview_outline.delete(*treeview_outline.get_children()) |
||
| 313 | |||
| 314 | # Display the items in the document |
||
| 315 | c_levelsItem = [""] |
||
| 316 | project_tree = None if state is None else state.project_tree |
||
| 317 | the_document = None |
||
| 318 | if project_tree is not None: |
||
| 319 | assert state is not None |
||
| 320 | try: |
||
| 321 | the_document = project_tree.find_document(state.session_selected_document) |
||
| 322 | except DoorstopError: |
||
| 323 | pass # The document is not found. |
||
| 324 | for item in [] if the_document is None else the_document.items: |
||
| 325 | theParent = next(iter(reversed([x for x in c_levelsItem[:item.depth]])), "") |
||
| 326 | |||
| 327 | while len(c_levelsItem) < item.depth: |
||
| 328 | c_levelsItem.append(item.uid) |
||
| 329 | c_levelsItem = c_levelsItem[:item.depth] |
||
| 330 | for _ in range(item.depth): |
||
| 331 | c_levelsItem.append(item.uid) |
||
| 332 | |||
| 333 | # Add the item to the document outline |
||
| 334 | def makeSuperscript(aLevel: Level) -> str: |
||
| 335 | return str(aLevel).strip().translate({48: 0x2070, 49: 0x00B9, 50: 0x00B2, 51: 0x00B3, 52: 0x2074, 53: 0x2075, 54: 0x2076, 55: 0x2077, 56: 0x2078, 57: 0x2079}) |
||
| 336 | try: |
||
| 337 | the_outline_text = item.text.splitlines()[0] |
||
| 338 | except IndexError: |
||
| 339 | the_outline_text = "" |
||
| 340 | treeview_outline.insert(theParent, tk.END, item.uid, text=makeSuperscript(item.level) if not item.active else item.level, values=(item.uid, the_outline_text), open=item.uid in c_openItem) |
||
| 341 | |||
| 342 | # Set tree view selection |
||
| 343 | c_selectedItem = state.session_selected_item if state else [] |
||
| 344 | if c_selectedItem: |
||
| 345 | assert state is not None |
||
| 346 | # Restore selection |
||
| 347 | session_selected_item_principal = state.session_selected_item_principal |
||
| 348 | treeview_outline.selection_set(c_selectedItem) |
||
| 349 | treeview_outline.focus(session_selected_item_principal) |
||
| 350 | treeview_outline.see(session_selected_item_principal) |
||
| 351 | |||
| 352 | store.add_observer(lambda store: refresh_document_outline(store)) |
||
| 353 | |||
| 354 | # Add a Vertical scrollbar to the Treeview Outline |
||
| 355 | treeview_outline_verticalScrollBar = widget.ScrollbarV(frame, command=treeview_outline.yview) |
||
| 356 | treeview_outline_verticalScrollBar.grid(row=2, column=0, columnspan=1, **kw_gs) |
||
| 357 | treeview_outline.configure(yscrollcommand=treeview_outline_verticalScrollBar.set) |
||
| 358 | treeview_outline.bind("<<TreeviewSelect>>", treeview_outline_treeviewselect) |
||
| 359 | treeview_outline.bind("<Delete>", lambda event: store.dispatch(Action_RemoveSelectedItem())) |
||
| 360 | treeview_outline.grid(row=2, column=1, columnspan=6, **kw_gsp) |
||
| 361 | |||
| 362 | if True: # Level edit buttons |
||
| 363 | btn_Level_Dedent = widget.Button(frame, text="<", width=0, command=lambda: store.dispatch(Action_SelectedItem_Level_Dedent())) |
||
| 364 | btn_Level_Dedent.grid(row=3, column=1, sticky=tk.EW, padx=(2, 0)) |
||
| 365 | btn_Level_Increment = widget.Button(frame, text="v", width=0, command=lambda: store.dispatch(Action_SelectedItem_Level_Increment())) |
||
| 366 | btn_Level_Increment.grid(row=3, column=2, sticky=tk.EW) |
||
| 367 | btn_Level_Decrement = widget.Button(frame, text="^", width=0, command=lambda: store.dispatch(Action_SelectedItem_Level_Decrement())) |
||
| 368 | btn_Level_Decrement.grid(row=3, column=3, sticky=tk.EW) |
||
| 369 | btn_Level_Indent = widget.Button(frame, text=">", width=0, command=lambda: store.dispatch(Action_SelectedItem_Level_Indent())) |
||
| 370 | btn_Level_Indent.grid(row=3, column=4, sticky=tk.EW, padx=(0, 2)) |
||
| 371 | |||
| 372 | def refresh_btn_Level(store: Optional[Store]) -> None: # Refresh the buttons level |
||
| 373 | state = store.state if store is not None else None |
||
| 374 | btn_Level_Dedent.config(state=tk.DISABLED if ((state is None) or (state.session_selected_item_principal is None)) else tk.NORMAL) |
||
| 375 | btn_Level_Increment.config(state=tk.DISABLED if ((state is None) or (state.session_selected_item_principal is None)) else tk.NORMAL) |
||
| 376 | btn_Level_Decrement.config(state=tk.DISABLED if ((state is None) or (state.session_selected_item_principal is None)) else tk.NORMAL) |
||
| 377 | btn_Level_Indent.config(state=tk.DISABLED if ((state is None) or (state.session_selected_item_principal is None)) else tk.NORMAL) |
||
| 378 | |||
| 379 | store.add_observer(lambda store: refresh_btn_Level(store)) |
||
| 380 | |||
| 381 | if True: # Button add item |
||
| 382 | def add_new_item() -> None: |
||
| 383 | """Add a new item to the document.""" |
||
| 384 | store.dispatch(Action_AddNewItemNextToSelection()) |
||
| 385 | btn_add_item = widget.Button(frame, text="Add Item", command=add_new_item) |
||
| 386 | btn_add_item.grid(row=3, column=5, sticky=tk.W, **kw_gp) |
||
| 387 | |||
| 388 | def refresh_btn_add_item(store: Optional[Store]) -> None: |
||
| 389 | state = store.state if store else None |
||
| 390 | btn_add_item.config(state=tk.DISABLED if ((state is None) or (state.session_selected_document is None)) else tk.NORMAL) |
||
| 391 | |||
| 392 | store.add_observer(lambda store: refresh_btn_add_item(store)) |
||
| 393 | |||
| 394 | if True: # Button remove item |
||
| 395 | def remove_selected_item() -> None: |
||
| 396 | """Remove selected item to the document.""" |
||
| 397 | store.dispatch(Action_RemoveSelectedItem()) |
||
| 398 | btn_remove_item = widget.Button(frame, text="Remove Selected Item", command=remove_selected_item) |
||
| 399 | btn_remove_item.grid(row=3, column=6, sticky=tk.E, **kw_gp) |
||
| 400 | |||
| 401 | def refresh_btn_remove_item(store: Optional[Store]) -> None: |
||
| 402 | state = store.state if store is not None else None |
||
| 403 | btn_remove_item.config(state=tk.DISABLED if ((state is None) or (state.session_selected_item_principal is None)) else tk.NORMAL) |
||
| 404 | |||
| 405 | store.add_observer(lambda store: refresh_btn_remove_item(store)) |
||
| 406 | |||
| 407 | return frame |
||
| 408 | |||
| 409 | def frame_item(root) -> ttk.Frame: |
||
| 410 | """Frame for the currently selected item.""" |
||
| 411 | # Configure grid |
||
| 412 | frame = ttk.Frame(root, **kw_f) |
||
| 413 | frame.rowconfigure(0, weight=0) |
||
| 414 | frame.rowconfigure(1, weight=4) |
||
| 415 | frame.rowconfigure(2, weight=0) |
||
| 416 | frame.rowconfigure(3, weight=1) |
||
| 417 | frame.rowconfigure(4, weight=1) |
||
| 418 | frame.rowconfigure(5, weight=1) |
||
| 419 | frame.rowconfigure(6, weight=1) |
||
| 420 | frame.rowconfigure(7, weight=0) |
||
| 421 | frame.rowconfigure(8, weight=0) |
||
| 422 | frame.rowconfigure(9, weight=0) |
||
| 423 | frame.rowconfigure(10, weight=0) |
||
| 424 | frame.rowconfigure(11, weight=4) |
||
| 425 | frame.columnconfigure(0, weight=0, pad=kw_f['padding'] * 2) |
||
| 426 | frame.columnconfigure(1, weight=1) |
||
| 427 | frame.columnconfigure(2, weight=1) |
||
| 428 | |||
| 429 | @_log |
||
| 430 | def text_item_focusout(event: Any) -> None: |
||
| 431 | """Handle updated item text.""" |
||
| 432 | state = store.state |
||
| 433 | if state is not None: |
||
| 434 | thewidget = event.widget |
||
| 435 | value = thewidget.get('1.0', tk.END) |
||
| 436 | item_uid = state.session_selected_item_principal |
||
| 437 | if item_uid: |
||
| 438 | store.dispatch(Action_ChangeItemText(item_uid, value)) |
||
| 439 | |||
| 440 | @_log |
||
| 441 | def text_item_reference_focusout(event: Any) -> None: |
||
| 442 | """Handle updated item reference text.""" |
||
| 443 | if store is not None: |
||
| 444 | state = store.state |
||
| 445 | if state is not None: |
||
| 446 | thewidget = event.widget |
||
| 447 | value = thewidget.get() |
||
| 448 | item_uid = state.session_selected_item_principal |
||
| 449 | if item_uid: |
||
| 450 | store.dispatch(Action_ChangeItemReference(item_uid, value)) |
||
| 451 | |||
| 452 | @_log |
||
| 453 | def text_extendedvalue_focusout(event) -> None: |
||
| 454 | """Handle updated extended attributes.""" |
||
| 455 | if store is not None: |
||
| 456 | state = store.state |
||
| 457 | if state is not None: |
||
| 458 | thewidget = event.widget |
||
| 459 | value = thewidget.get('1.0', tk.END) |
||
| 460 | item_uid = state.session_selected_item_principal |
||
| 461 | if item_uid: |
||
| 462 | store.dispatch(Action_ChangeExtendedValue(item_uid, state.session_extended_name, value)) |
||
| 463 | |||
| 464 | if True: # Selected Item label |
||
| 465 | lbl_selected_item = widget.Label(frame, text="No item selected") |
||
| 466 | lbl_selected_item.grid(row=0, column=0, columnspan=3, sticky=tk.W, **kw_gp) |
||
| 467 | |||
| 468 | def refreshSelectedItemLabel(store: Optional[Store]) -> None: |
||
| 469 | state = store.state if store is not None else None |
||
| 470 | session_selected_item_principal = state.session_selected_item_principal if state is not None else None |
||
| 471 | if session_selected_item_principal is None: |
||
| 472 | lbl_selected_item.config(text="No item selected") |
||
| 473 | else: |
||
| 474 | lbl_selected_item.config(text="Selected Item: " + str(session_selected_item_principal)) |
||
| 475 | store.add_observer(lambda store: refreshSelectedItemLabel(store)) |
||
| 476 | |||
| 477 | if True: # Item text |
||
| 478 | text_item = widget.Text(frame, width=width_text, height=height_text, wrap=tk.WORD) |
||
| 479 | text_item.bind('<FocusOut>', text_item_focusout) |
||
| 480 | text_item.grid(row=1, column=0, columnspan=3, **kw_gsp) |
||
| 481 | |||
| 482 | def refreshItemText(store: Optional[Store]) -> None: |
||
| 483 | state = store.state if store else None |
||
| 484 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 485 | project_tree = state.project_tree if state else None |
||
| 486 | try: |
||
| 487 | item = None if session_selected_item_principal is None else project_tree.find_item(session_selected_item_principal) if project_tree is not None else None |
||
| 488 | except DoorstopError: |
||
| 489 | item = None |
||
| 490 | text_item.replace('1.0', tk.END, "" if item is None else item.text) |
||
| 491 | text_item.config(state=tk.DISABLED if session_selected_item_principal is None else tk.NORMAL) |
||
| 492 | store.add_observer(lambda store: refreshItemText(store)) |
||
| 493 | |||
| 494 | widget.Label(frame, text="Properties:").grid(row=2, column=0, sticky=tk.W, **kw_gp) |
||
| 495 | widget.Label(frame, text="Links:").grid(row=2, column=1, columnspan=2, sticky=tk.W, **kw_gp) |
||
| 496 | |||
| 497 | View Code Duplication | if True: # CheckBox active |
|
| 498 | checkbox_active_var = tk.BooleanVar() |
||
| 499 | |||
| 500 | def doChangeActive() -> None: |
||
| 501 | state = store.state if store else None |
||
| 502 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 503 | project_tree = state.project_tree if state else None |
||
| 504 | try: |
||
| 505 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 506 | except DoorstopError: |
||
| 507 | item = None |
||
| 508 | if item: |
||
| 509 | store.dispatch(Action_ChangeItemActive(item, checkbox_active_var.get())) |
||
| 510 | checkbox_active = widget.Checkbutton(frame, command=doChangeActive, variable=checkbox_active_var, text="Active") |
||
| 511 | checkbox_active.grid(row=3, column=0, sticky=tk.W, **kw_gp) |
||
| 512 | |||
| 513 | def refreshCheckButtonActive(store: Optional[Store]) -> None: |
||
| 514 | state = store.state if store else None |
||
| 515 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 516 | project_tree = state.project_tree if state else None |
||
| 517 | try: |
||
| 518 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 519 | except DoorstopError: |
||
| 520 | item = None |
||
| 521 | checkbox_active_var.set(bool(item is not None and item.active)) |
||
| 522 | checkbox_active.config(state=tk.DISABLED if item is None else tk.NORMAL) |
||
| 523 | store.add_observer(lambda store: refreshCheckButtonActive(store)) |
||
| 524 | |||
| 525 | View Code Duplication | if True: # CheckBox derived |
|
| 526 | checkbox_derived_var = tk.BooleanVar() |
||
| 527 | |||
| 528 | def doChangeDerived() -> None: |
||
| 529 | state = store.state if store else None |
||
| 530 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 531 | project_tree = state.project_tree if state else None |
||
| 532 | try: |
||
| 533 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 534 | except DoorstopError: |
||
| 535 | item = None |
||
| 536 | if item: |
||
| 537 | store.dispatch(Action_ChangeItemDerived(item, checkbox_derived_var.get())) |
||
| 538 | |||
| 539 | checkbox_derived = widget.Checkbutton(frame, command=doChangeDerived, variable=checkbox_derived_var, text="Derived") |
||
| 540 | checkbox_derived.grid(row=4, column=0, sticky=tk.W, **kw_gp) |
||
| 541 | |||
| 542 | def refreshCheckButtonDerived(store: Optional[Store]) -> None: |
||
| 543 | state = store.state if store else None |
||
| 544 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 545 | project_tree = state.project_tree if state else None |
||
| 546 | try: |
||
| 547 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 548 | except DoorstopError: |
||
| 549 | item = None |
||
| 550 | checkbox_derived_var.set(bool(item is not None and item.derived)) |
||
| 551 | checkbox_derived.config(state=tk.DISABLED if item is None else tk.NORMAL) |
||
| 552 | store.add_observer(lambda store: refreshCheckButtonDerived(store)) |
||
| 553 | |||
| 554 | View Code Duplication | if True: # CheckBox normative |
|
| 555 | checkbox_normative_var = tk.BooleanVar() |
||
| 556 | |||
| 557 | def doChangeNormative() -> None: |
||
| 558 | state = store.state if store else None |
||
| 559 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 560 | project_tree = state.project_tree if state else None |
||
| 561 | try: |
||
| 562 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 563 | except DoorstopError: |
||
| 564 | item = None |
||
| 565 | if item: |
||
| 566 | store.dispatch(Action_ChangeItemNormative(item, checkbox_normative_var.get())) |
||
| 567 | checkbox_normative = widget.Checkbutton(frame, command=doChangeNormative, variable=checkbox_normative_var, text="Normative") |
||
| 568 | checkbox_normative.grid(row=5, column=0, sticky=tk.W, **kw_gp) |
||
| 569 | |||
| 570 | def refreshCheckButtonNormative(store: Optional[Store]) -> None: |
||
| 571 | state = store.state if store else None |
||
| 572 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 573 | project_tree = state.project_tree if state else None |
||
| 574 | try: |
||
| 575 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 576 | except DoorstopError: |
||
| 577 | item = None |
||
| 578 | checkbox_normative_var.set(bool(item is not None and item.normative)) |
||
| 579 | checkbox_normative.config(state=tk.DISABLED if item is None else tk.NORMAL) |
||
| 580 | store.add_observer(lambda store: refreshCheckButtonNormative(store)) |
||
| 581 | |||
| 582 | View Code Duplication | if True: # CheckBox heading |
|
| 583 | checkbox_heading_var = tk.BooleanVar() |
||
| 584 | |||
| 585 | def doChangeHeading() -> None: |
||
| 586 | state = store.state if store else None |
||
| 587 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 588 | project_tree = state.project_tree if state else None |
||
| 589 | try: |
||
| 590 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 591 | except DoorstopError: |
||
| 592 | item = None |
||
| 593 | if item: |
||
| 594 | store.dispatch(Action_ChangeItemHeading(item, checkbox_heading_var.get())) |
||
| 595 | |||
| 596 | checkbox_heading = widget.Checkbutton(frame, command=doChangeHeading, variable=checkbox_heading_var, text="Heading") |
||
| 597 | checkbox_heading.grid(row=6, column=0, sticky=tk.W, **kw_gp) |
||
| 598 | |||
| 599 | def refreshCheckButtonHeading(store: Optional[Store]) -> None: |
||
| 600 | state = store.state if store else None |
||
| 601 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 602 | project_tree = state.project_tree if state else None |
||
| 603 | try: |
||
| 604 | item = project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 605 | except DoorstopError: |
||
| 606 | item = None |
||
| 607 | checkbox_heading_var.set(bool(item is not None and item.heading)) |
||
| 608 | checkbox_heading.config(state=tk.DISABLED if item is None else tk.NORMAL) |
||
| 609 | store.add_observer(lambda store: refreshCheckButtonHeading(store)) |
||
| 610 | |||
| 611 | if True: # Listbox Links |
||
| 612 | listbox_links = widget.Listbox(frame, width=width_uid, height=6, selectmode=tk.EXTENDED, exportselection=tk.OFF) |
||
| 613 | listbox_links.grid(row=3, column=1, rowspan=4, **kw_gsp) |
||
| 614 | |||
| 615 | def refreshListBoxLinks(store: Optional[Store]) -> None: |
||
| 616 | previous_active_index = listbox_links.index(tk.ACTIVE) |
||
| 617 | previous_active_item = listbox_links.get(previous_active_index) |
||
| 618 | |||
| 619 | state = None if store is None else store.state |
||
| 620 | session_selected_item_principal = None if state is None else state.session_selected_item_principal |
||
| 621 | session_selected_link = [] if state is None else state.session_selected_link |
||
| 622 | project_tree = None if state is None else state.project_tree |
||
| 623 | try: |
||
| 624 | item = None if project_tree is None else project_tree.find_item(session_selected_item_principal) |
||
| 625 | except DoorstopError: |
||
| 626 | item = None |
||
| 627 | listbox_links.delete(0, tk.END) |
||
| 628 | if item is not None: |
||
| 629 | assert state is not None |
||
| 630 | v_new_index = -1 |
||
| 631 | next_active = None |
||
| 632 | for uid in sorted([x for x in item.links if (("" == state.session_link_inception) or (state.session_link_inception in str(x)))], key=lambda x: str(x), reverse=False): |
||
| 633 | v_new_index += 1 |
||
| 634 | listbox_links.insert(tk.END, uid) |
||
| 635 | if str(uid) in session_selected_link: |
||
| 636 | listbox_links.selection_set(listbox_links.index(tk.END) - 1) |
||
| 637 | if str(uid) == str(previous_active_item): |
||
| 638 | next_active = v_new_index |
||
| 639 | |||
| 640 | if next_active is None: |
||
| 641 | next_active = min(previous_active_index, listbox_links.size() - 1) |
||
| 642 | assert next_active is not None |
||
| 643 | if 0 <= next_active: |
||
| 644 | listbox_links.activate(next_active) |
||
| 645 | listbox_links.see(next_active) |
||
| 646 | |||
| 647 | store.add_observer(lambda store: refreshListBoxLinks(store)) |
||
| 648 | |||
| 649 | def handle_document_listbox_selectionchange(evt) -> None: |
||
| 650 | w = evt.widget |
||
| 651 | the_selection = w.curselection() |
||
| 652 | |||
| 653 | a = frozenset([w.get(int(i)) for i in the_selection]) |
||
| 654 | b = frozenset([w.get(int(i)) for i in range(0, w.size()) if i not in [int(j) for j in the_selection]]) |
||
| 655 | store.dispatch(Action_ChangeSelectedLink(selected_link=a, unselected_link=b)) |
||
| 656 | |||
| 657 | listbox_links.bind('<<ListboxSelect>>', handle_document_listbox_selectionchange) |
||
| 658 | |||
| 659 | if True: # Entry link inception |
||
| 660 | |||
| 661 | entry_link_inception = widget.Entry(frame, width=width_uid) |
||
| 662 | |||
| 663 | def doChangeInceptionLink(): |
||
| 664 | store.dispatch(Action_ChangeLinkInception(entry_link_inception.get())) |
||
| 665 | entry_link_inception.bind("<KeyRelease>", lambda event: doChangeInceptionLink()) |
||
| 666 | entry_link_inception.grid(row=3, column=2, sticky=tk.EW + tk.N, **kw_gp) |
||
| 667 | |||
| 668 | def refreshEntryLinkInception(store: Optional[Store]) -> None: |
||
| 669 | state = None if store is None else store.state |
||
| 670 | the_link_inception = "" if state is None else state.session_link_inception |
||
| 671 | if the_link_inception != entry_link_inception.get(): |
||
| 672 | entry_link_inception.delete('0', tk.END) |
||
| 673 | entry_link_inception.insert('0', the_link_inception) |
||
| 674 | store.add_observer(lambda store: refreshEntryLinkInception(store)) |
||
| 675 | |||
| 676 | if True: # Link item button |
||
| 677 | @_log |
||
| 678 | def do_link() -> None: |
||
| 679 | """Add the specified link to the current item.""" |
||
| 680 | state = store.state |
||
| 681 | if state is not None: |
||
| 682 | the_item_uid = state.session_selected_item_principal |
||
| 683 | if the_item_uid is not None: |
||
| 684 | the_new_link = state.session_link_inception |
||
| 685 | if the_new_link is not None: |
||
| 686 | store.dispatch(Action_ChangeItemAddLink(the_item_uid, UID(the_new_link))) |
||
| 687 | |||
| 688 | btn_link_item = widget.Button(frame, text="<< Link Item", command=do_link) |
||
| 689 | btn_link_item.grid(row=4, column=2, **kw_gp) |
||
| 690 | |||
| 691 | def refreshLinkButton(store: Optional[Store]) -> None: |
||
| 692 | state = store.state if store is not None else None |
||
| 693 | if state is not None: |
||
| 694 | session_link_inception = state.session_link_inception |
||
| 695 | if "" != session_link_inception: |
||
| 696 | |||
| 697 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 698 | project_tree = state.project_tree if state else None |
||
| 699 | try: |
||
| 700 | item = project_tree.find_item(session_selected_item_principal) if project_tree is not None else None |
||
| 701 | except DoorstopError: |
||
| 702 | item = None |
||
| 703 | if item is not None: |
||
| 704 | if session_link_inception in [str(x) for x in item.links]: |
||
| 705 | btn_link_item.config(state=tk.DISABLED) |
||
| 706 | else: |
||
| 707 | btn_link_item.config(state=tk.NORMAL) |
||
| 708 | else: |
||
| 709 | btn_link_item.config(state=tk.DISABLED) |
||
| 710 | else: |
||
| 711 | btn_link_item.config(state=tk.DISABLED) |
||
| 712 | store.add_observer(lambda store: refreshLinkButton(store)) |
||
| 713 | |||
| 714 | if True: # Unlink item button |
||
| 715 | |||
| 716 | @_log |
||
| 717 | def unlink() -> None: |
||
| 718 | """Remove the currently selected link from the current item.""" |
||
| 719 | state = store.state |
||
| 720 | if state is not None: |
||
| 721 | uid = state.session_selected_item_principal |
||
| 722 | if uid is not None: |
||
| 723 | store.dispatch(Action_ChangeItemRemoveLink(uid, state.session_selected_link)) |
||
| 724 | |||
| 725 | btn_unlink_item = widget.Button(frame, text=">> Unlink Item", command=unlink) |
||
| 726 | btn_unlink_item.grid(row=6, column=2, **kw_gp) |
||
| 727 | |||
| 728 | def refreshUnlinkButton(store: Optional[Store]) -> None: |
||
| 729 | state = store.state if store is not None else None |
||
| 730 | if state is not None: |
||
| 731 | session_selected_link = state.session_selected_link |
||
| 732 | btn_unlink_item.config(state=tk.NORMAL if session_selected_link else tk.DISABLED) |
||
| 733 | store.add_observer(lambda store: refreshUnlinkButton(store)) |
||
| 734 | |||
| 735 | widget.Label(frame, text="External Reference:").grid(row=7, column=0, columnspan=3, sticky=tk.W, **kw_gp) |
||
| 736 | |||
| 737 | if True: # Item External Reference |
||
| 738 | text_item_reference = widget.Entry(frame, width=width_text) |
||
| 739 | text_item_reference.bind('<FocusOut>', text_item_reference_focusout) |
||
| 740 | text_item_reference.grid(row=8, column=0, columnspan=3, **kw_gsp) |
||
| 741 | |||
| 742 | def refreshItemReference(store: Optional[Store]) -> None: |
||
| 743 | state = store.state if store else None |
||
| 744 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 745 | project_tree = state.project_tree if state else None |
||
| 746 | try: |
||
| 747 | item = None if session_selected_item_principal is None else project_tree.find_item(session_selected_item_principal) if project_tree is not None else None |
||
| 748 | except DoorstopError: |
||
| 749 | item = None |
||
| 750 | text_item_reference.delete(0, tk.END) |
||
| 751 | text_item_reference.insert(0, "" if item is None else item.ref) |
||
| 752 | text_item_reference.config(state=tk.DISABLED if session_selected_item_principal is None else tk.NORMAL) |
||
| 753 | store.add_observer(lambda store: refreshItemReference(store)) |
||
| 754 | |||
| 755 | widget.Label(frame, text="Extended Attributes:").grid(row=9, column=0, columnspan=3, sticky=tk.W, **kw_gp) |
||
| 756 | |||
| 757 | if True: # Combobox Extended attribute Name |
||
| 758 | combobox_extended = widget.Combobox(frame) |
||
| 759 | combobox_extended.grid(row=10, column=0, columnspan=3, **kw_gsp) |
||
| 760 | |||
| 761 | def refreshComboboxExtendedName(store: Optional[Store]) -> None: |
||
| 762 | state = store.state if store else None |
||
| 763 | session_selected_item_principal = state.session_selected_item_principal if state else None |
||
| 764 | project_tree = state.project_tree if state is not None else None |
||
| 765 | try: |
||
| 766 | item = None if session_selected_item_principal is None else project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 767 | except DoorstopError: |
||
| 768 | item = None |
||
| 769 | |||
| 770 | values = None if item is None else item.extended |
||
| 771 | combobox_extended['values'] = values or [] |
||
| 772 | combobox_extended.delete(0, tk.END) |
||
| 773 | if state is not None and state.session_extended_name: |
||
| 774 | combobox_extended.insert(0, state.session_extended_name) |
||
| 775 | combobox_extended.config(state=tk.DISABLED if session_selected_item_principal is None else tk.NORMAL) |
||
| 776 | |||
| 777 | store.add_observer(lambda store: refreshComboboxExtendedName(store)) |
||
| 778 | |||
| 779 | def handle_extended_name_combobox_selectionchange(*event: Any) -> None: |
||
| 780 | if store: |
||
| 781 | store.dispatch(Action_ChangeExtendedName(combobox_extended.get())) |
||
| 782 | combobox_extended.bind("<<ComboboxSelected>>", handle_extended_name_combobox_selectionchange) |
||
| 783 | combobox_extended.bind("<KeyRelease>", handle_extended_name_combobox_selectionchange) |
||
| 784 | |||
| 785 | if True: # Textbox Extended attribute Value |
||
| 786 | text_extendedvalue = widget.Text(frame, width=width_text, height=height_ext, wrap=tk.WORD) |
||
| 787 | text_extendedvalue.grid(row=11, column=0, columnspan=3, **kw_gsp) |
||
| 788 | |||
| 789 | def refreshTextboxExtendedValue(store: Optional[Store]) -> None: |
||
| 790 | state = store.state if store is not None else None |
||
| 791 | session_selected_item_principal = state.session_selected_item_principal if state is not None else None |
||
| 792 | project_tree = state.project_tree if state is not None else None |
||
| 793 | try: |
||
| 794 | item = None if session_selected_item_principal is None else project_tree.find_item(session_selected_item_principal) if project_tree else None |
||
| 795 | except DoorstopError: |
||
| 796 | item = None |
||
| 797 | |||
| 798 | value = "" if ((item is None) or (state is None)) else item.get(state.session_extended_name) |
||
| 799 | text_extendedvalue.delete(1.0, tk.END) |
||
| 800 | if state is not None and state.session_extended_name: |
||
| 801 | if value: |
||
| 802 | text_extendedvalue.insert(tk.END, value) |
||
| 803 | text_extendedvalue.config(state=tk.DISABLED if session_selected_item_principal is None else tk.NORMAL) |
||
| 804 | |||
| 805 | store.add_observer(lambda store: refreshTextboxExtendedValue(store)) |
||
| 806 | |||
| 807 | text_extendedvalue.bind('<FocusOut>', text_extendedvalue_focusout) |
||
| 808 | |||
| 809 | return frame |
||
| 810 | |||
| 811 | def frame_family(root) -> ttk.Frame: |
||
| 812 | """Frame for the parent and child document items.""" |
||
| 813 | # Configure grid |
||
| 814 | frame = ttk.Frame(root, **kw_f) |
||
| 815 | frame.rowconfigure(0, weight=0) |
||
| 816 | frame.rowconfigure(1, weight=1) |
||
| 817 | frame.rowconfigure(2, weight=0) |
||
| 818 | frame.rowconfigure(3, weight=1) |
||
| 819 | frame.columnconfigure(0, weight=1) |
||
| 820 | |||
| 821 | @_log |
||
| 822 | def followlink(uid: UID) -> None: |
||
| 823 | """Display a given uid.""" |
||
| 824 | # Load the good document. |
||
| 825 | store.dispatch(Action_ChangeSelectedDocument(uid.prefix)) |
||
| 826 | |||
| 827 | # load the good Item |
||
| 828 | store.dispatch(Action_ChangeSelectedItem((uid,))) |
||
| 829 | |||
| 830 | # Place widgets Text Parents |
||
| 831 | widget.Label(frame, text="Linked To:").grid(row=0, column=0, sticky=tk.W, **kw_gp) |
||
| 832 | text_parents = widget.noUserInput_init(widget.Text(frame, width=width_text, wrap=tk.WORD)) |
||
| 833 | text_parents_hyperlink = utilTkinter.HyperlinkManager(text_parents) # pylint: disable=W0201 |
||
| 834 | text_parents.tag_configure("refLink", foreground="blue") |
||
| 835 | text_parents.grid(row=1, column=0, **kw_gsp) |
||
| 836 | |||
| 837 | def refresh_text_parents(store: Optional[Store]) -> None: |
||
| 838 | # Display the items this item links to |
||
| 839 | state = None if store is None else store.state |
||
| 840 | if state is not None: |
||
| 841 | widget.noUserInput_delete(text_parents, '1.0', tk.END) |
||
| 842 | text_parents_hyperlink.reset() |
||
| 843 | if state.session_selected_item_principal is not None: |
||
| 844 | project_tree = state.project_tree |
||
| 845 | if project_tree is not None: |
||
| 846 | for uid in project_tree.find_item(state.session_selected_item_principal).links: |
||
| 847 | try: |
||
| 848 | item = project_tree.find_item(uid) |
||
| 849 | except DoorstopError: |
||
| 850 | text = "???" |
||
| 851 | else: |
||
| 852 | text = item.text or item.ref or '???' |
||
| 853 | uid = item.uid |
||
| 854 | |||
| 855 | widget.noUserInput_insert(text_parents, tk.END, "{t}".format(t=text)) |
||
| 856 | widget.noUserInput_insert(text_parents, tk.END, " [") |
||
| 857 | widget.noUserInput_insert(text_parents, tk.END, uid, text_parents_hyperlink.add(lambda c_theURL: followlink(c_theURL), uid, ["refLink"])) # pylint: disable=W0108 |
||
| 858 | widget.noUserInput_insert(text_parents, tk.END, "]\n\n") |
||
| 859 | store.add_observer(lambda store: refresh_text_parents(store)) |
||
| 860 | |||
| 861 | widget.Label(frame, text="Linked From:").grid(row=2, column=0, sticky=tk.W, **kw_gp) |
||
| 862 | text_children = widget.noUserInput_init(widget.Text(frame, width=width_text, wrap=tk.WORD)) |
||
| 863 | text_children_hyperlink = utilTkinter.HyperlinkManager(text_children) # pylint: disable=W0201 |
||
| 864 | text_children.tag_configure("refLink", foreground="blue") |
||
| 865 | text_children.grid(row=3, column=0, **kw_gsp) |
||
| 866 | |||
| 867 | def refresh_text_children(store: Optional[Store]) -> None: |
||
| 868 | # Display the items this item links to |
||
| 869 | state = None if store is None else store.state |
||
| 870 | if state is not None: |
||
| 871 | # Display the items this item has links from |
||
| 872 | widget.noUserInput_delete(text_children, '1.0', 'end') |
||
| 873 | text_children_hyperlink.reset() |
||
| 874 | if state.session_selected_item_principal is not None: |
||
| 875 | project_tree = state.project_tree |
||
| 876 | if project_tree is not None: |
||
| 877 | parent_item = project_tree.find_item(state.session_selected_item_principal) |
||
| 878 | if parent_item is not None: |
||
| 879 | for uid in parent_item.find_child_links(): |
||
| 880 | item = project_tree.find_item(uid) |
||
| 881 | text = item.text or item.ref or '???' |
||
| 882 | uid = item.uid |
||
| 883 | |||
| 884 | widget.noUserInput_insert(text_children, tk.END, "{t}".format(t=text)) |
||
| 885 | widget.noUserInput_insert(text_children, tk.END, " [") |
||
| 886 | widget.noUserInput_insert(text_children, tk.END, uid, text_children_hyperlink.add(lambda c_theURL: followlink(c_theURL), uid, ["refLink"])) # pylint: disable=W0108 |
||
| 887 | widget.noUserInput_insert(text_children, tk.END, "]\n\n") |
||
| 888 | store.add_observer(lambda store: refresh_text_children(store)) |
||
| 889 | |||
| 890 | return frame |
||
| 891 | |||
| 892 | # Place widgets |
||
| 893 | frame_document(result_frame).grid(row=0, column=0, columnspan=1, **kw_gs) |
||
| 894 | frame_item(result_frame).grid(row=0, column=1, columnspan=1, **kw_gs) |
||
| 895 | frame_family(result_frame).grid(row=0, column=2, columnspan=1, **kw_gs) |
||
| 896 | |||
| 897 | return result_frame |
||
| 898 | |||
| 1151 |