ASCII Designer

• ASCII Designer Manual
  • What is this?
  • AutoFrame overview
  • Toolkit
  • Grid slicing, stretching and anchors
    • Slicing
    • Stretch
    • Anchoring
  • Widget specification
    • Control ID
    • Notes about specific widgets
  • Value and event binding
    • Control objects
    • Event binding
    • Virtual value attribute
    • TK Textbox / Combobox conversion + validation
  • List / Tree View
    • Editing
    • Trees
    • Toolkit-native identifiers
  • Menus
  • Nested Layouts
  • Extending / integrating
    • Toolkit-native methods
    • Embedding AutoFrame into a 3rd-party host window
    • Including 3rd-party controls into an AutoFrame
    • Nesting AutoFrame
    • Custom widget classes
• Translating forms
  • Loading translations from a package
    • Remarks
  • Loading translations from a file
  • Generating or updating translation files
  • To see if there are any translations missing in the GUI
  • Adding custom translations
• API documentation (autogenerated)
  • ascii_designer package
  • ascii_designer.autoframe module
    • AutoFrame
  • ascii_designer.ascii_slice module
    • MCell
    • SlicedGrid
    • merged_cells()
    • slice_grids()
  • ascii_designer.toolkit module
    • ListBinding
    • ToolkitBase
    • auto_id()
    • get_toolkit()
    • set_toolkit()
  • ascii_designer.toolkit_tk module
    • ToolkitTk
  • ascii_designer.toolkit_qt module
    • ToolkitQt
  • ascii_designer.i18n module
    • Translations
    • load_translations_json()
    • save_translations_json()
  • ascii_designer.list_model module
    • ObsList
    • retrieve()
    • store()
  • ascii_designer.tk_treeview module
    • ListBindingTk
    • make_treelist()
  • ascii_designer.tk_treeedit module
    • TreeEdit
  • ascii_designer.tk_generic_var module
    • GenericVar
    • Invalid
    • ge0()
    • gt0()
    • nullable()
  • ascii_designer.event module
    • CancelEvent
    • Event
    • event()

Changelog

Version 2.0.0

BREAKING: Rework event system.

• Events are now strictly-typed. Instanciation events without prototype is not allowed anymore.

• Do away with positional-/named conversion. I.e. by_name parameter is gone. Instead, * or / marker should be used in the prototype to make arguments keyword-only or positional-only. Not enforced yet for compatibility.

• Add-handler, remove-handler, trigger operations are now fully type-hinted.

• Better handling of exceptions in event handlers. They can now be logged (default), printed or reraised either individiually or as a group.

Lots of typehinting was done. Stuff might have been broken. Other:

• Fix missing implementation of AutoFrame.f_translations_get_prefixed(). (Issue #28)

• AutoFrame: Set f_controls[""] on build if parent is given.

Changelog up to v1.0

• v1.0.0

  • It is now possible to define nested layouts in f_body.

  • Finally do the step to v1.0.

• v0.6.1

  • Fix #25: doubleclick-to-edit on tree cell also opens/closes tree

  • Fix #20: Enter and Escape key press leaking out of tree edit box

• v0.6.0:

  • Enhance Event system: Event can now be used as decorator; choose between positional-args and named-args behavior

  • Can set listvariable.allow_reorder to enable/disable reordering by dragging items. (tk/ttk only)

  • Can set listvariable.allow_sorting to enable/ disable GUI sorting. Default True.

  • Add Translation.get_prefix, Translations.get_exception and AutoFrame.f_translations_get_prefixed helpers.

  • Fix broken list sorting.

  • Fix exception when using “id:text” menu entries.

• v0.5.2:

  • Add translation support.

• v0.5.1:

  • TK: add add_setup toolkit option (similar to setup_style but keeps the defaults)

  • ObsList: add tuple indexing (experimental).

• v0.5.0:

  • TK/TTK: Add GenericVar supporting automatic conversion and validated-hook; opt-in automatic update of control’s invalid state. See TK Textbox / Combobox conversion + validation

  • introduce Toolkit.widget_classes attribute, allowing injection of custom widget subclasses

  • export EventSource, CancelEvent, Invalid, nullable, gt0, ge0 on package-level

• v0.4.4:

  • Fix edit-widget placement issues in Tk Treeedit

  • Treeedit subwidgets are now ttk (i.e. stylable)

  • Treeedit autoedit_added property

  • Fix icon “inheritance” on Windows

• v0.4.3:

  • Fix f_icon not working on Windows (with .ico files).

  • Tk (choice only) dropdown: fire event immediately on selection, not on FocusOut / Return press

  • Change virtual-value handling of placeholders. Placeholder “remembers” and returns what was assigned to it. Also, when assigned an unbuilt AutoFrame instance, it will automatically build it, reducing boilerplate for the typical embedding case.

• v0.4.2:

  • Fix 2 issues in ListBindingTk related to editable lists.

• v0.4.1:

  • Make tk_treeedit key bindings a class property (list) that can be modified. Fix crash on Windows due to nonexisting Keysym.

• v0.4.0:

  • Refactor internal implementation of List Binding. Architecture simplified to ObsList (data model) and ListBinding classes.

  • Add basic editing capabilites to List / Tree view.

• v0.3.4:

  • Add setup_style parameter to ToolkitTk for custom style setup

  • Fix #6: for some Tk controls, value change via code would trigger the control’s autoconnected handler.

• v0.3.3:

  • Qt now depends on qtpy, not PyQt4 anymore.

  • set_toolkit can set Options. Add font_size and ttk_theme option for Tkinter.

  • Can set window icon by f_icon property

• v0.3.2:

  • Add “ttk” toolkit (which is actually ToolkitTk with a new option). YMMV.

  • Add f_on_build and f_on_show hooks

  • Fix several bugs in control parser, esp. concerning labels.

• v0.3.1: Qt Toolkit menu accelerators

• v0.3.0: menus added (TBD: accelerators for Qt menus); fix Qt List crash

• v0.2.0: rework of the list model

Developers

The project is located at https://github.com/loehnertj/ascii_designer

This is a hobby project. If you need something quick, contact me or better, send a pull request.

Indices and tables

• Index

• Module Index

• Search Page