Version 0.6.5

[MyreMylar]

Version 0.6.5 - Now with multi-line Text Entry

Upgrade with: pip install pygame_gui -U

This update was building on the work done in 0.6.0 with text to finally add a multi-line text entry UI element, and along the way a range of other smaller issues were fixed.

Major Features

• NEW UITextEntryBox - Allows for the entering/editing of plain text into a word-wrapped, multi-line box. The aim was to model it closely on Windows Notepad in terms of features and behaviour.

Minor features & enhancements

• NEW TEXT_EFFECT_SHAKE - Another text effect that applies a shaking effect to words in text boxes.
• Better support for key word arguments for translations - most elements with text now support a text_kwargs type parameter that you can pass a dictionary of keywords too - useful if you have data to insert into translated strings.
• NEW Polish translation - Thanks to @marcinbarylka.
• UIDropDown enhancements - It should now open with the selected item visible in the list, allow scrolling the list with the mouse and allow for the list to be updated without having to recreate the drop down from scratch.
• Dynamic theming changes - there are now options to update the theming of elements via functions while the application is running.
• Centre anchors for layouts - should make it easier to stick elements in the middle of containers and have them stay there.
• Reducing boilerplate code - UIManagers should now be an optional parameter for all elements (you still need to make at least one), I've also begun some work on passing in a four element tuple instead of a pygame.Rect which should pare down the text passed into elements down to the very minimum required.

Auto-generated pull request notes

These are all the pull requests merged for 0.6.5.

• UIProgressBar themes weren't showing in TOC by @ConquerProgramming1 in UIProgressBar themes weren't showing in TOC #259
• fix issue sending new line character to UITextEntryLine via set_text crashes TextBoxLayoutRow (TypeError: 'NoneType' object is not subscriptable) #273 where newline character causes crash for text_box_layo… by @wadsworj in fix issue #273 where newline character causes crash for text_box_layo… #274
• Deprecate set_image() for everything except UIImage by @MyreMylar in Deprecate set_image() for everything except UIImage #279
• Fixes & tests to improve coverage & resolve bugs related to untested code by @MyreMylar in Fixes & tests to improve coverage & resolve bugs related to untested code #280
• Fix for text box not returning to top on scroll bar removal by @MyreMylar in Fix for text box not returning to top on scroll bar removal #281
• Add KMOD_META as hopefully mac CMD key for keyboard shortcuts by @MyreMylar in Add KMOD_META as hopefully mac CMD key for keyboard shortcuts #283
• Fix for file dialog file list not updating when resizing the dialog by @MyreMylar in Fix for file dialog file list not updating when resizing the dialog #282
• Add capability to add & remove items/options to already existing menus & lists by @MyreMylar in Add capability to add & remove items/options to already existing menus & lists #284
• Improve test coverage for UI Label by @MyreMylar in Improve test coverage for UI Label #286
• A series of small testing coverage improvements by @MyreMylar in A series of small testing coverage improvements #287
• A couple more coverage fixes by @MyreMylar in A couple more coverage fixes #288
• Improve UITextEntryLine test coverage by @MyreMylar in Improve UITextEntryLine test coverage #289
• Improve test coverage - batch of fixes by @MyreMylar in Improve test coverage - batch of fixes #290
• Further improvements to UI Elements testing coverage by @MyreMylar in Further improvements to UI Elements testing coverage #291
• Further coverage elements improve by @MyreMylar in Further coverage elements improve #292
• More element coverage fixes & bug fix for selection list by @MyreMylar in More element coverage fixes & bug fix for selection list #296
• Try to improve scrolling container coverage by @MyreMylar in Try to improve scrolling container coverage #298
• First stabs at boosting test coverage for File Dialog by @MyreMylar in First stabs at boosting test coverage for File Dialog #299
• Text box test coverage improvements by @MyreMylar in Text box test coverage improvements #300
• Fix bool extraction for link params in text box by @MyreMylar in Fix bool extraction for link params in text box #301
• Try adding windows test runner to CI by @MyreMylar in Try adding windows test runner to CI #302
• First stab at adding macos test runner by @MyreMylar in First stab at adding macos test runner #303
• See if adding a ParserBase init call pleases LGTM by @MyreMylar in See if adding a ParserBase init call pleases LGTM #304
• Improve test coverage in core module by @MyreMylar in Improve test coverage in core module #305
• Start ui element test coverage improvements by @MyreMylar in Start ui element test coverage improvements #306
• Improve test coverage in Core submodule by @MyreMylar in Improve test coverage in Core submodule #307
• Improve appearance theme coverage by @MyreMylar in Improve appearance theme coverage #308
• Improve text submodule test coverage by @MyreMylar in Improve text submodule test coverage #309
• Improve text coverage again by @MyreMylar in Improve text coverage again #310
• Improve text box layout coverage & fix img tag bug by @MyreMylar in Improve text box layout coverage & fix img tag bug #311
• Improve text line chunk coverage by @MyreMylar in Improve text line chunk coverage #312
• Last coverage branch by @MyreMylar in Last coverage branch #313
• Update text effects when first assigned to a text owner by @MyreMylar in Update text effects when first assigned to a text owner #314
• Add placeholder text input parameter to text entry line by @MyreMylar in Add placeholder text input parameter to text entry line #315
• Add clear() to text box and text line by @MyreMylar in Add clear() to text box and text line #316
• Add HOME & END key support to text entry line by @MyreMylar in Add HOME & END key support to text entry line #318
• Add optional pre-parse step to UITextBox converting /n to
  by @MyreMylar in Add optional pre-parse step to UITextBox converting /n to <br> #319
• Add global default UIManager option by @MyreMylar in Add global default UIManager option #320
• Add option to drop down menu so only open/close button expands by @MyreMylar in Add option to drop down menu so only open/close button expands #321
• Change drop down to scroll to selected item in list by @MyreMylar in Change drop down to scroll to selected item in list #322
• Refactor text effect file structure by @MyreMylar in Refactor text effect file structure #323
• Add shake effect to text box chunks by @MyreMylar in Add shake effect to text box chunks #324
• change text key word arguments param into dictionary on init by @MyreMylar in change text key word arguments param into dictionary on init #326
• Add translation text key word argument dictionary params by @MyreMylar in Add translation text key word argument dictionary params #327
• Add new centering anchors for element positioning by @MyreMylar in Add new centering anchors for element positioning #330
• Add Polish translation file by @marcinbarylka in Add Polish translation file #336
• pin importlib_resources version to 5.9.0 by @MyreMylar in pin importlib_resources version to 5.9.0 #340
• Remove lgtm, expand linux test to include python 3.10 by @MyreMylar in Remove lgtm, expand linux test to include python 3.10 #341
• fix crash in file dialog when backspacing on selected file by @MyreMylar in fix crash in file dialog when backspacing on selected file #342
• Add dynamic theming updates & start of text entry box by @MyreMylar in Add dynamic theming updates & start of text entry box #339
• Adding a functional Text Entry Box by @MyreMylar in Adding a functional Text Entry Box #344

New Contributors

• @wadsworj made their first contribution in fix issue #273 where newline character causes crash for text_box_layo… #274
• @marcinbarylka made their first contribution in Add Polish translation file #336

Full Changelog: v_064...v_065

Known Issues

• No tab support in new text entry box.
• No undo/redo CTRL+Z/CTRL+SHIFT+Z support in new text entry box.

Thanks for reading!

---

This discussion was created from the release Version 0.6.5.