Improve "Show available fonts" dialog #1075

uliska · 2018-07-17T23:15:09Z

Closes #420
Closes #1077

This PR is not ready to be merged but I would like to get some feedback. I want more functionality, but actually the code would be a significant improvement already now.

[EDIT:] I've removed the "WIP" from the title and consider the PR ready by now.

The output of the LilyPond=>Show Available Fonts... command is practically unusable when more than a few fonts are available on a system. It is totally overwhelming, and the structure is hard to understand. Therefore I wanted to have an improved presentation of the data.

In its initial state the PR doesn't simply print out the LilyPond output but parses it to a number of dictionaries. The most important one is the families dictionary with entries for each font family. For now an ordered and structured list is printed to the same log window as was previously in that dialog. The "filter" line edit is still non-functional.

To be done:

Replace the log widget with a custom widget. What I think would be appropriate is a list-style widget where initially only the font families are listed. Only upon "opening" an entry will additional information be loaded and displayed (and these can then be pretty detailed).
Implement the filter edit. When some text is typed into that line edit all fonts not matching the pattern should be suppressed by making their parent widget invisible.
Add an export/print/save function

The code could be merged without these additional features, after removing the non-functional filter edit.

This is the first installment fo an improved dialog for showing available fonts. So far this parses the results to a number of dictionaries and lists but doesn't do anything with it. TODO: Properly parse the details of a font family TODO: Create a new custom widget: - show all font families as a table - each table row can be expanded to show more details about the family TODO: Search/Filter - An additional text input allows for incremental filtering for font families QUESTION: Do we need to show config files and font dirs?

This is the preparation for a usable presentation to be done in a next step. The available font families are parsed into a dictionary, which can be used to populate the data model of a to-be-determined visualization widget.

fedelibre · 2018-07-18T02:29:01Z

This PR and in particular the filter would fix issue #420

uliska · 2018-07-18T09:33:13Z

Oh yes, I had completely forgotten about that open issue.

In order to proceed we need

A suitable GUI "view" widget for display (see below)
A (custom?) Qt "model"
A QSortFilterProxyModel that will help with the sorting and filtering.

I haven't done anything with Qt's model-view-controller paradigm, and I don't know which UI interface would be suitable. It has to be something that allows unfolding a details section like in QTreeView. I think this would be my first try:

Have the family name as the first column of a toplevel entry
If there is only one sub-font (Hack would be an example) put the style name(s) in the second column
If there are more than one sub-fonts (Helvetica LT has ...Cond, ...Fractions, ...ExtCompressed etc.) create child elements for each.
If the sub-font has only one style put the style name(s) in the second column
If the sub-font has more styles (Helvetica LT Cond has Black, Black Oblique, Bold, Regular, Oblique, Light and Light Oblique on my PC) create child elements for each.
The style sub-sub-elements can have the style name(s) in the single first column

- Hack => Regular
+ Aachen Std
  - Aachen Std => Regular, Bold
  - Aachen Std Bold => Regular, Bold
+ Helvetica LT Std
  + Cond
    - Condensed, Regular
    - Bold Condensed, Bold
    - Bold Condensed Oblique, Bold Italic
    - Condensed Oblique, Italic
  + Regular
   ...

(BTW the screenshot and the initial PR incorrectly merges the third level styles, presumably having the last one overwrite all the others.)

Displaying the log output lets the user inspect the raw material if they want to. In addition it makes the waiting time for the results feel more "natural". The results are displayed in the second tab which is automatically opened when the job has completed. TODO: So far this still uses a Log() for the result display, which is completely inappropriate.

This commit fixes an issue with parsing and attaching multiple styles. Additionally it fleshes out the routine to display the fonts in hierarchical order. So far this is done into the old Log widget but the logic behind the "tree building" should be portable to any new approach using the model-view structure.

These hat previously been overlooked (case in point for the need for this improvement ;-) )

uliska · 2018-07-18T12:00:16Z

I've improved (ehm, fixed) the parsing and mapping of font families, weights and styles into a dictionary and provided a preliminary reporting. Additionally I've added a tab widget to have access to the original LilyPond output and the other provided information:

Next steps (but I'm afraid I have to turn to other things first):

Display the font families using QTreeView, QSortFilterProxyModel and a custom (?) model
Make the line input work with the filter proxy

This dialog will become a little bit more sophisticated, and I think it shouldn't be squeezed in the engrave.lytools module

uliska · 2018-07-18T17:57:36Z

I would like this to be tested now, especially with regard to the hierarchy and display of the font tree. I've now changed the presentation from the hijacked Log window to a proper tree view:

~~Still to be done: Filtering (but given today's experience with the tree view and Qt's model/view architecture this may be pretty straightforward).~~

~~Also to be done: The results should be cached and only be updated when requested explicitly.~~

TODO: Provide method to manually update

This is just an intermediate linting step

In repsonse to wish #1077 this makes the toplevel entries consistently behave only as an index with the family name. All details go to child entries, even if there is only one name.

Previously a filter was also applied to child elements, effectively hiding style entries that don't carry the family name anymore.

fedelibre · 2018-07-19T10:57:57Z

I've tested it and it looks great!

System fonts are grouped and listed correctly.
I have only an issue with notation fonts, namely LilyPond's Emmentaler and the fonts made by Abraham (an old version, last modification time is october 2015).
As you can see below, the various font sizes are not grouped together so the output is a bit confusing:

uliska · 2018-07-19T11:09:28Z

Thanks. I will have a look into it and see if I can fix that too. Apart from that things have even more improved by now, and I think we're soon ready to merge:

A styled sample is given for each font style (translatable string BTW)
Results are cached, so LilyPond is run only once (TODO: Button to manually refresh that)

Note that you can use regular expressions in the line edit. Specifically useful are the begin/end characters ^ and $.

uliska · 2019-09-09T13:21:55Z

Finally ;-)

This partially reverts commit 37ae63e. The modifications to logwidget.py had been committed erroneously

The "Music font repository" is a local directory where the user can save their notation fonts. If that is set all fonts can be directly installed without having to look up the directory with the "Install..." button. With the "Auto install" option this will be done whenever the font dialog is opened, so any new LilyPond installation can automatically be provided with the notation fonts.

Update the existing page for "Paths" Preferences

This doesn't properly work yet and is only committed in order to make it possible to test the issue. As explained in a comment to #1169 the user guide is displayed *behind* the dialog (or even the application window), or probably the other way round: the dialog insists on remaining at the front.

Have one global MusicFontRepo object (if the path is given in the preferences).

This replaces Pull Request #949 with proper implementations (and more) # Add fileMode argument to __init__ While not changing the default this allows setting the filemode upon instantiation. # Add mustExist validagion If set to True the file must exist. As long as the path set in the lineEdit doesn't exist the text is colored, and when trying to leave the widget while it points to a non-existent path it is instead reset to its previous value. # Add editingFinished signal Signal is emitted when the editing has finished. Treats the lineEdit and the dialog as one entity: When the lineEdit loses focus because the button has been clicked the signal is *not* emitted.

Streamline the creation process of the dialog and its subwidgets. Review responsibilities (store/do stuff where it belongs)

Base The Document Fonts dialog on QDialog instead of widgets.dialog.Dialog. Streamline the dialog creation, make more stuff available through methods, reduce dependencies between objects.

This fixes the issue with the Help button described in #1169 (comment)

Referring to the main dialog through subwidgets' self.window() method instead of keeping a manual reference (self._dialog) ensures proper destruction of all objects upon closing of the dialog. This fixes the main issue in #1169, the exception in app.aboutToQuit.

This was a workaround to a side-effect from #1169 that isn't necessary anymore.

The cleaning up was not only necessary as part of the workaround but also to ensure current jobs are canceled when the preview restarts prematurely (due to the rather new handling in the job queue).

A (semi-)transparent "waiting" animation that can be attached to arbitrary QWidgets.

as provided by Abraham Lee

uliska · 2019-09-12T12:09:17Z

With the exception of the manual page I think I'm now through with what I want to have included in the merge - anything else may go to the future wishlist ...

This screencast shows:

The new (unpolished) glyph specimen sheet
The (slightly) rewritten dialog
(again:) Caching in place, only some changes trigger a compilation
A completely new "waiting" animation instead of a progress bar. This was necessary because the progress bar doesn't have any meaningful estimate of the time the compilation will take. The animation is done as a new widget that can very easily be attached to other widgets in the application.

uliska · 2019-09-13T06:35:38Z

Superseded by #1173

uliska added 2 commits July 17, 2018 12:23

Parse font families to dictionary

239845d

This is the preparation for a usable presentation to be done in a next step. The available font families are parsed into a dictionary, which can be used to populate the data model of a to-be-determined visualization widget.

uliska requested review from PeterBjuhr, wbsoft and fedelibre July 17, 2018 23:15

uliska added 4 commits July 18, 2018 12:33

Add tabs to display config files and font directories

546f43d

Also report configuration directories

d8fea42

These hat previously been overlooked (case in point for the need for this improvement ;-) )

uliska added 2 commits July 18, 2018 19:02

WIP: add tab for/with QTreeWidget

a781e32

Move "show available fonts" dialog to new fontdialog module

7690f1a

This dialog will become a little bit more sophisticated, and I think it shouldn't be squeezed in the engrave.lytools module

uliska mentioned this pull request Jul 18, 2018

Questions about the Show Available Fonts dialog #1076

Closed

uliska added 2 commits July 18, 2018 19:48

Replace output in Log with a tree view

3391abb

Suppress header in TreeView

a89c362

uliska added 4 commits July 18, 2018 20:45

Let the dialog be filtered by the line edit

d2e7611

Cache font results

efe7a11

TODO: Provide method to manually update

Linting (WIP)

b19fd0e

This is just an intermediate linting step

Replace additional tabs with one "Misc" model/view tab

62fca84

uliska mentioned this pull request Jul 18, 2018

Available Fonts: Show samples #1077

Closed

uliska added 3 commits July 19, 2018 01:38

Change the hierarchy (make somewhat more general)

9ff92dd

In repsonse to wish #1077 this makes the toplevel entries consistently behave only as an index with the family name. All details go to child entries, even if there is only one name.

Add styled font samples

3d58013

Fix filtering (ignore child elements in filtering)

b80e9d9

Previously a filter was also applied to child elements, effectively hiding style entries that don't carry the family name anymore.

Remember width of font-name column

0dfa003

Use provided LineEdit widget from the widgets module

3183477

uliska mentioned this pull request Sep 9, 2019

Technical issues with the Document Fonts dialog #1169

Closed

uliska added 6 commits September 9, 2019 23:41

Revert "Drop "Reload", replace with "Restore Defaults""

605985d

This partially reverts commit 37ae63e. The modifications to logwidget.py had been committed erroneously

Document Fonts Preferences

83eb184

Update the existing page for "Paths" Preferences

Add stub for "download fonts" dialog

594a33b

Some cleanup of fonts.__init__.py

1ed5b76

Have one global MusicFontRepo object (if the path is given in the preferences).

uliska force-pushed the show-available-fonts branch from 4a9b0fb to 1ed5b76 Compare September 10, 2019 13:46

uliska mentioned this pull request Sep 11, 2019

WIP: UrlRequester additions #949

Closed

UrlRequester: Supress signal when path hasn't changed

f9f76bf

uliska mentioned this pull request Sep 11, 2019

UrlRequester: add autocompleter #1171

Open

uliska added 12 commits September 11, 2019 12:32

WIP (mostly code cleanup)

bc65442

Streamline the creation process of the dialog and its subwidgets. Review responsibilities (store/do stuff where it belongs)

musicpreview.py: Better handling, new showProgress option

fa1d29b

Use self.dialog() in FontDialog subwidgets

579e2ca

Further Code Cleanup (QDialog)

e410991

Base The Document Fonts dialog on QDialog instead of widgets.dialog.Dialog. Streamline the dialog creation, make more stuff available through methods, reduce dependencies between objects.

Document Fonts dialog: Modality

118a81c

This fixes the issue with the Help button described in #1169 (comment)

Remove cleanup from musicpreview

0c507ac

This was a workaround to a side-effect from #1169 that isn't necessary anymore.

Partially restore code from previous commit

77bb767

The cleaning up was not only necessary as part of the workaround but also to ensure current jobs are canceled when the preview restarts prematurely (due to the rather new handling in the job queue).

Add widgets.waitingoverlay

5fbd2ba

A (semi-)transparent "waiting" animation that can be attached to arbitrary QWidgets.

MusicPreviewWidget supports waiting overlay

31590b6

Make font preview use waiting overlay

4695d2c

Glyph sampler

444a790

as provided by Abraham Lee

uliska force-pushed the show-available-fonts branch from e78cf07 to 444a790 Compare September 12, 2019 12:00

uliska mentioned this pull request Sep 13, 2019

Document Fonts dialog #1173

Merged

uliska closed this Sep 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve "Show available fonts" dialog #1075

Improve "Show available fonts" dialog #1075

uliska commented Jul 17, 2018 •

edited

fedelibre commented Jul 18, 2018

uliska commented Jul 18, 2018

uliska commented Jul 18, 2018

uliska commented Jul 18, 2018 •

edited

fedelibre commented Jul 19, 2018

uliska commented Jul 19, 2018

uliska commented Sep 9, 2019

uliska commented Sep 12, 2019

uliska commented Sep 13, 2019

Improve "Show available fonts" dialog #1075

Improve "Show available fonts" dialog #1075

Conversation

uliska commented Jul 17, 2018 • edited

To be done:

fedelibre commented Jul 18, 2018

uliska commented Jul 18, 2018

uliska commented Jul 18, 2018

uliska commented Jul 18, 2018 • edited

fedelibre commented Jul 19, 2018

uliska commented Jul 19, 2018

uliska commented Sep 9, 2019

uliska commented Sep 12, 2019

uliska commented Sep 13, 2019

uliska commented Jul 17, 2018 •

edited

uliska commented Jul 18, 2018 •

edited