Skip to content

Display dictionary description

Antoine Belvire requested to merge feature/dictionary_description into master

Context

Add dictionary description to dictionary list passed to DictionaryPresenter. This allows UIs to display dictionary descriptions when listing dictionaries.

In GUI, looks like this:

croiseur-gui dictionary description

Not used in CLI: Description may not fit on one line and there is no dictionary info <dictionary> command to display multi-line information.

What has changed?

Main Changes

common, spi-dictionary

  • Renamed *DictionaryDescription to *DictionaryDetails to avoid confusion (*DictionaryDetails contains several fields whose one is named description). Lots of impacts everywhere. Performed the change in a dedicated commit without functional change to ease the review.

gui

  • Added the new description field to tooltip of dictionary list cells.

Side Effects

Everywhere

  • Just impacts of the renaming of *DictionaryDescription, no functional change.

Others

common, gui, cli

  • Added convenience methods to access fields from DictionaryDetails from ProvidedDictionaryDetails and used it there.
Edited by Antoine Belvire

Merge request reports