Création d’un nouveau widget

La présente page explique comment créer les widgets - QtWidgets.QWidget - et autres objets QT (QtWidgets.QGridLayout, QtWidgets.QMenu, QtGui.QAction) qui formeront le formulaire de consultation / édition des métadonnées à partir du dictionnaire des widgets. On suppose que le programme est en train de boucler sur les clés dudit dictionnaire.

Soit :

• widgetsdict le dictionnaire contenant tous les widgets et leurs informations de paramétrage (cf. Génération du dictionnaire des widgets), objet de classe plume.rdf.widgetsdict.WidgetsDict.

• widgetkey la clé de l’enregistrement en cours de traitement, objet de classe plume.rdf.widgetkey.WidgetKey.

La valeur associée à widgetkey dans le dictionnaire de widgets, c’est-à-dire widgetsdict[widgetkey], est un objet de classe plume.rdf.internaldict.InternalDict dit « dictionnaire interne ».

Chaque enregistrement du dictionnaire des widgets contrôle un widget principal et, le cas échéant, un ou plusieurs widgets annexes. Non seulement son dictionnaire interne donne les informations nécessaires à leur création, mais certaines de ses clés servent à référencer les objets Qt créés.

Widget principal : Type • Stockage • Placement dans la grille • Widget masqué ? • Paramètres spécifiques aux widgets QGroupBox • Paramètres spécifiques aux widgets QToolButton • Paramètres spécifiques aux widgets de saisie • Paramètres spécifiques aux widgets QLineEdit et QTextEdit • Paramètres spécifiques aux widgets QComboBox • Paramètres spécifiques aux widgets QDateEdit, QDateTimeEdit et QTimeEdit • Paramètres spécifiques aux widgets QLabel

Widgets annexes : Widget annexe : grille • Widget annexe : étiquette • Widget annexe : bouton de sélection de la source • Widget annexe : bouton de sélection de la langue • Widget annexe : bouton de sélection de l’unité • Widget annexe : bouton d’aide à la saisie des géométries • Widget annexe : bouton « moins » • Widget annexe : bouton de calcul

Le widget principal et les widgets annexes sont totalement indépendants. Ils peuvent être simplement créés les uns à la suite des autres, de la manière suivante :

    # commandes de création du widget principal, variables
    # selon le type :
    if widgetsdict[widgetkey]['main widget type'] == 'QGroupBox':
        ...	
    elif widgetsdict[widgetkey]['main widget type'] == ...
        ...
    # etc.

    # commandes de création du widget annexe d'étiquette,
    # s'il y a lieu :
    if widgetsdict[widgetkey]['has label']:
        ...

    # commandes de création du widget annexe de sélection de
    # la source, s'il y a lieu :
    if widgetsdict[widgetkey]['multiple sources']:
        ...
        
    # commandes de création du widget annexe de sélection de
    # la langue, s'il y a lieu :
    if widgetsdict[widgetkey]['authorized languages']:
        ...

    # commandes de création du widget annexe de sélection de
    # l'unité, s'il y a lieu :
    if widgetsdict[widgetkey]['units']:
        ...
    
    # commandes de création du widget annexe d'aide à la saisie
    # des géométries, s'il y a lieu :
    if widgetsdict[widgetkey]['geo tools']:
        ...
    
    # commandes de création du widget annexe bouton moins,
    # s'il y a lieu :
    if widgetsdict[widgetkey]['has minus button']:
        ...

    # commandes de création du widget annexe de calcul,
    # s'il y a lieu :
    if widgetsdict[widgetkey]['has compute button']:
        ...

Les commandes à exécuter sont détaillées dans la suite.

Widget principal

Type

Le type du widget principal (QGroupBox, QToolButton, QLineEdit…) est fourni par la clé 'main widget type' du dictionnaire interne.

widgetsdict[widgetkey]['main widget type']

Si 'main widget type' ne contient aucune valeur, il n’y a pas lieu de créer de widget. Ceci ne se produit en pratique que pour la clé-racine du dictionnaire, qui est également référencée par l’attribut plume.rdf.widgetsdict.WidgetsDict.root et n’appelle aucune action.

Stockage

Le nouveau widget a vocation à être stocké dans la clé 'main widget' du dictionnaire interne.

widgetsdict[widgetkey]['main widget'] = main_widget

Où main_widget est le widget principal qui vient d’être créé.

Placement dans la grille

Les informations ci-après ne valent pas pour les onglets (cf. Onglets).

Le nouveau widget doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'main widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(main_widget, row, column, rowSpan, columnSpan)

main_widget est le widget principal qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du widget principal de la clé. La même méthode sera utilisée ensuite pour connaître le placement de ses widgets annexes, avec en second argument le nom du widget annexe considéré.

Les grilles sont elles-mêmes des widgets annexes associés aux clés de groupes. Cf. Widget annexe : grille.

↑ haut de page

Widget masqué ?

Certains widgets seront à masquer ou afficher selon les actions de l’utilisateur. Ceci concerne par exemple les boutons de traduction, qui devront être masqués si une traduction a déjà été saisie pour chacune des langues autorisées. Autre cas : lorsqu’une métadonnée peut être saisie au choix sous la forme d’un URI ou d’un ensemble de propriétés littérales, les widgets servant pour la forme non sélectionnée sont masqués tant que l’utilisateur ne décide pas de changer de source (cf. Widget annexe : bouton de sélection de la source).

Concrètement, le widget principal et tous les widgets annexes d’un enregistrement devront être masqués dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

Paramètres spécifiques aux widgets QGroupBox

Deux cas doivent être distingués lorsque 'main widget type' vaut 'QGroupBox' : les onglets et les autres groupes.

Onglets

Les onglets sont reconnaissables au fait que la condition suivante est remplie :

if widgetsdict[widgetkey]['object'] == 'tab':
    ...

Ils correspondent aux onglets du formulaire. Contrairement à tous les autres widgets, ils n’auront donc pas vocation à être placés dans un QGridLayout (la partie Placement dans la grille ne s’applique pas à eux), mais devront être insérés en tant que pages dans le QTabWidget qui portera le formulaire. Le QTabWidget en question ne fait pas l’objet d’un enregistrement du dictionnaire et devra avoir été créé au préalable.

Les libellés des onglets sont, comme pour toutes les étiquettes, fournis par la clé 'label' du dictionnaire interne.

widgetsdict[widgetkey]['label']

Autres groupes

Pour tous les autres groupes, c’est-à-dire ceux pour lesquels la valeur de la clé 'object' n’est pas 'tab'.

• La partie Placement dans la grille s’applique.

• L”étiquette - paramètre title du QGroupBox - est fournie par la clé 'label' du dictionnaire interne.

widgetsdict[widgetkey]['label']

Cette clé ne sera renseignée que s’il y a lieu d’afficher un libellé sur le groupe.

• Lorsqu’elle est renseignée, la clé 'help text' fournit un texte d’aide (descriptif de la catégorie de métadonnée), qui pourrait alimenter un toolTip (voire un whatsThis).

widgetsdict[widgetkey]['main widget'].setToolTip(widgetsdict[widgetkey]['help text'])

• La couleur du cadre du QGroupBox dépendra de la nature du groupe, soit de la valeur de la clé 'object' ou plus simplement la valeur renvoyée par :

widgetsdict.group_kind(widgetkey)

On pourra utiliser les valeurs par défaut suivantes :

Type de groupe	group_kind(widgetkey)	Couleur
Groupe de propriétés	'group of properties'	'#958B62'
Groupe de valeurs	'group of values'	'#5770BE'
Groupe de traduction	'translation group'	'#FF8D7E'

Paramètres spécifiques aux widgets QToolButton

Les seuls cas où le widget principal est un QToolButton sont ceux des « boutons plus » et « boutons de traduction », qui permettent à l’utilisateur d’ajouter réciproquement des valeurs ou traductions supplémentaires. La clé 'object' vaut alors 'plus button' ou 'translation button'.

• L’image à utiliser est toujours plus_button.svg, mais la couleur dépendra du type de groupe dans lequel se trouve le bouton, soit de la valeur renvoyée par :

widgetsdict.group_kind(widgetkey)

Comme pour les QGroupBox, on pourra utiliser les valeurs par défaut suivantes :

Type de groupe	group_kind(widgetkey)	Couleur
Groupe de propriétés	'group of properties'	'#958B62'
Groupe de valeurs	'group of values'	'#5770BE'
Groupe de traduction	'translation group'	'#FF8D7E'

NB. En pratique, il n’y a pas de bouton plus dans les groupes de propriétés, donc la couleur associée ne sera jamais utilisée dans ce contexte.

Soit color la couleur souhaitée pour le bouton et raw_svg le contenu du fichier plus_button.svg, on pourra appliquer la couleur avec :

colored_svg = raw_svg.format(fill=color)

• Le texte d’aide à afficher en infobulle sur le bouton se trouve dans la clé 'text help' du dictionnaire.

widgetsdict[widgetkey]['text help']

Paramètres spécifiques aux widgets de saisie

• Lorsqu’elle existe (car préalablement renseignée dans la fiche de métadonnées), la valeur à afficher dans le widget est fournie par la clé 'value' du dictionnaire.

  
  widgetsdict[widgetkey]['value']
  
  

• Si la clé 'read only' vaut True, le widget doit être visible mais désactivé, pour empêcher les modifications manuelles par l’utilisateur.

  
  widgetsdict[widgetkey]['read only']
  
  

• La clé 'is mandatory' contient un booléen indiquant s’il est obligatoire (valeur True) ou non (valeur False ou None) de saisir une valeur pour la catégorie.

  
  widgetsdict[widgetkey]['is mandatory']
  
  

• Si la clé 'value help text' contient une valeur, elle devra être affichée en infobulle sur la valeur.

  
  widgetsdict[widgetkey]['value help text']
  
  

  'value help text' est toujours prioritaire sur 'help text' lorsqu’elle est renseignée, mais elle ne s’applique qu’au widget principal qui contient la valeur, pas à ses widgets annexes.

Paramètres spécifiques aux widgets QLineEdit et QTextEdit

Pour les widgets d’édition de texte, le dictionnaire apporte divers paramètres complémentaires. Ils sont tous optionnels. Si la clé ne contient pas de valeur, c’est qu’il n’y a pas lieu d’utiliser le paramètre.

• 'placeholder text' donne la valeur fictive à afficher dans le widget :

widgetsdict[widgetkey]['main widget'].setPlaceholderText(widgetsdict[widgetkey]['placeholder text'])

• 'input mask' donne le masque de saisie :

widgetsdict[widgetkey]['main widget'].setInputMask(widgetsdict[widgetkey]['input mask'])

• 'type validator' indique si un validateur basé sur le type doit être défini et lequel :

mTypeValidator = widgetsdict[widgetkey]['type validator']

if mTypeValidator == 'QIntValidator':
    widgetsdict[widgetkey]['main widget'].setValidator(QIntValidator(widgetsdict[widgetkey]['main widget']))
elif mTypeValidator == 'QDoubleValidator':
    widgetsdict[widgetkey]['main widget'].setValidator(QDoubleValidator(widgetsdict[widgetkey]['main widget']))

Ces validateurs permettent également de définir des valeurs minimum et maximum autorisées. Comme le SHACL le permet également (avec sh:minInclusive et sh:maxInclusive, car les paramètres bottom et top de QIntValidator et QDoubleValidator sont inclusifs), cette possibilité pourrait être utilisée à l’avenir, mais aucune clé n’a été prévue en ce sens à ce stade.

• 'regex validator pattern' donne l”expression rationnelle que doit respecter la valeur saisie et 'regex validator flags' les options éventuelles :

if widgetsdict[widgetkey]['regex validator pattern']:
    qre = QRegularExpression(widgetsdict[widgetkey]['regex validator pattern'])

    if widgetsdict[widgetkey]['regex validator flags']:
        if 'i' in widgetsdict[widgetkey]['regex validator flags']:
            qre.setPatternOptions(QRegularExpression.CaseInsensitiveOption)        
        if 's' in widgetsdict[widgetkey]['regex validator flags']:
            qre.setPatternOptions(QRegularExpression.DotMatchesEverythingOption)
        if 'm' in widgetsdict[widgetkey]['regex validator flags']:
            qre.setPatternOptions(QRegularExpression.MultilineOption)
        if 'x' in widgetsdict[widgetkey]['regex validator flags']:
            qre.setPatternOptions(QRegularExpression.ExtendedPatternSyntaxOption)

    widgetsdict[widgetkey]['main widget'].setValidator(
        QRegularExpressionValidator(qre, widgetsdict[widgetkey]['main widget']))

Seules les options i, s, m et x sont à la fois admises en SHACL et par QT, ce sont donc les seules à être gérées.

Paramètres spécifiques aux widgets QComboBox

Liste des termes

La liste des termes à afficher dans le QComboBox est fournie par la clé 'thesaurus values' du dictionnaire interne.

widgetsdict[widgetkey]['thesaurus values']

Cette liste présentera toujours une chaîne de caractères vide '' en première position, pour représenter une absence de valeur. Lors de la sauvegarde, ces chaînes de caractères vides sont traitées comme des None.

Autant que possible - considérant la quantité de termes dans certains thésaurus - les QComboBox devraient afficher une ligne de saisie avec auto-complétion. Il est par contre important qu’ils ne permettent pas d’entrer d’autres valeurs que celles des thésaurus.

Placeholder

Comme les QTextEdit et QLineEdit, les widgets QComboBox peuvent afficher une valeur fictive fournie par la clé 'placeholder text'.

widgetsdict[widgetkey]['main widget'].setPlaceholderText(widgetsdict[widgetkey]['placeholder text'])

Paramètres spécifiques aux widgets QDateEdit, QDateTimeEdit et QTimeEdit

Les formats d’entrée (argument de QDateTime.fromString, QDate.fromString ou QTime.fromString), de sortie (argument de QDateTime.toString, QDate.toString ou QTime.toString) et d’affichage (argument de QDateTimeEdit.setDisplayFormat, QDateEdit.setDisplayFormat ou QTimeEdit.setDisplayFormat) sont toujours identiques :

Type de widget	Format
QDate	'dd/MM/yyyy'
QDateTime	'dd/MM/yyyy hh:mm:ss'
QTime	'hh:mm:ss'

Paramètres spécifiques aux widgets QLabel

NB : il n’est pas question dans cette partie des widgets annexes d’étiquettes mais du cas où le widget principal lui-même est un QLabel.

En mode lecture, des widgets QLabel remplacent la plupart des widgets de saisie (à ce jour tous sauf les QCheckBox). Ils permettent notamment d’afficher des hyperliens cliquables.

Comme pour les véritables widgets de saisie, la valeur à afficher est fournie par la clé 'value' du dictionnaire.

widgetsdict[widgetkey]['value']

Il importera d’activer le découpage sur plusieurs lignes :

widgetsdict[widgetkey]['main widget'].setWordWrap(True)

Ainsi sans doute que l’ouverture automatique des liens :

widgetsdict[widgetkey]['main widget'].setOpenExternalLinks(True)

Widget annexe : grille

Pour les onglets, groupes de valeurs, groupes de propriétés et groupes de traduction (en fait dès lors que 'main widget type' vaut 'QGroupBox'), un widget annexe QGridLayout doit être créé en paralèlle du QGroupBox.

Le widget QGridLayout sera stocké dans la clé 'grid widget' du dictionnaire interne.

widgetsdict[widgetkey]['grid widget'] = grid
widgetsdict[widgetkey]['main widget'].setLayout(grid)

Où grid est l’objet QGridLayout qui vient d’être créé.

↑ haut de page

Widget annexe : étiquette

Un QLabel doit être créé dès lors que la clé 'has label' du dictionnaire interne vaut True. En pratique, cela concernera les widgets de saisie dont la clé 'label' contient une valeur. Le libellé à afficher correspond bien entendu à la valeur de la clé 'label'.

if widgetsdict[widgetkey]['has label']:
    ...

Stockage

Le widget QLabel sera stocké dans la clé 'label widget' du dictionnaire interne.

widgetsdict[widgetkey]['label widget'] = label_widget

Où label_widget est le widget d’étiquette qui vient d’être créé.

Placement dans la grille

Le QLabel doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'label widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(label_widget, row, column, rowSpan, columnSpan)

label_widget est le QLabel qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du widget annexe d’étiquette de la clé.

Texte d’aide

Lorsqu’elle est renseignée, la clé 'help text' fournit un texte d’aide (descriptif de la catégorie de métadonnée), qui pourrait alimenter un toolTip (voire un whatsThis).

widgetsdict[widgetkey]['label widget'].setToolTip(widgetsdict[widgetkey]['help text'])

Widget masqué ?

Le QLabel doit être masqué dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

↑ haut de page

Widget annexe : bouton de sélection de la source

Un widget QToolButton de sélection de source doit être créé dès lors que la condition suivante est vérifiée :

if widgetsdict[widgetkey]['multiple sources']:
    ...

Stockage

Le widget de sélection de la source est stocké dans la clé 'switch source widget' du dictionnaire interne.

widgetsdict[widgetkey]['switch source widget'] = source_widget

Où source_widget est le widget de sélection de la source qui vient d’être créé.

Menu

Le QMenu associé au QToolButton est stocké dans la clé 'switch source menu' du dictionnaire.

widgetsdict[widgetkey]['switch source menu'] = source_menu

Où source_menu est le QMenu qui vient d’être créé.

Ce QMenu contient une QAction par thésaurus utilisable pour la métadonnée. Les QAction sont elles-mêmes stockées dans la clé 'switch source actions' du dictionnaire, sous la forme d’une liste.

widgetsdict[widgetkey]['switch source actions'].append(source_action)

Où source_action représente chaque QAction venant d’être créée.

Les libellés des QAction correspondent aux noms des thésaurus et sont fournis par la liste contenue dans la clé 'sources' du dictionnaire :

widgetsdict[widgetkey]['sources']

Pour la définition des actions, cf. Actions contrôlées par les widgets du formulaire.

Le thésaurus courant - celui qui fournit les valeurs du QComboBox - est mis en évidence dans le menu par l’icône selected_blue.svg : . Le nom de ce thésaurus est donné par la clé 'current source'.

widgetsdict[widgetkey]['current source']

Placement dans la grille

Le QToolButton doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'switch source widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(source_widget, row, column, rowSpan, columnSpan)

source_widget est le QToolButton qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du widget annexe de sélection de la source.

Icône

L’icône à utiliser pour le bouton de sélection de la source est fournie par le fichier source_button.svg. Contrairement aux boutons plus et moins, sa couleur est fixe à ce stade.

Texte d’aide

On pourra afficher en infobulle sur le bouton le texte suivant :

'Sélection du thésaurus ou mode de saisie'

Widget masqué ?

Le QToolButton doit être masqué dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

↑ haut de page

Widget annexe : bouton de sélection de la langue

Un widget QToolButton de sélection de langue doit être créé dès lors que la condition suivante est vérifiée (ce qui ne se produira que si le mode traduction est actif) :

if widgetsdict[widgetkey]['authorized languages']:
    ...

Stockage

Le bouton de sélection de la langue est stocké dans la clé 'language widget' du dictionnaire interne.

widgetsdict[widgetkey]['language widget'] = language_widget

Où language_widget est le widget de sélection de la langue qui vient d’être créé.

Menu

Le QMenu associé au QToolButton est stocké dans la clé 'language menu' du dictionnaire.

widgetsdict[widgetkey]['language menu'] = language_menu

Où language_menu est le QMenu qui vient d’être créé.

Ce QMenu contient une QAction par langue disponible. Les QAction sont elles-mêmes stockées dans la clé 'language actions' du dictionnaire, sous la forme d’une liste.

widgetsdict[widgetkey]['language actions'].append(language_action)

Où language_action représente chaque QAction venant d’être créée.

Les libellés des QAction correspondent aux noms abrégés des langues et sont fournis par la liste contenue dans la clé 'authorized languages' du dictionnaire :

widgetsdict[widgetkey]['authorized languages']

Pour la définition des actions, cf. Actions contrôlées par les widgets du formulaire.

Rendu

Au lieu d’une icône, le QToolButton de sélection de la langue montre un texte correspondant au nom abrégé de la langue sélectionnée. Celui-ci est fourni par la clé 'language value'.

widgetsdict[widgetkey]['language value']

La langue sélectionnée est également mise en évidence dans le menu par l’icône selected_blue.svg : .

Texte d’aide

On pourra afficher en infobulle sur le bouton le texte suivant :

'Sélection de la langue de la métadonnée'

Placement dans la grille

Le QToolButton doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'language widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(language_widget, row, column, rowSpan, columnSpan)

language_widget est le QToolButton qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du widget annexe de sélection de la langue.

Widget masqué ?

Le QToolButton doit être masqué dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

↑ haut de page

Widget annexe : bouton de sélection de l’unité

Un widget QToolButton de sélection de l’unité doit être créé dès lors que la condition suivante est vérifiée (ce qui ne se produira qu’en mode édition) :

if widgetsdict[widgetkey]['units']:
    ...

Pour l’heure, de tels widgets ne sont utilisés que pour spécifier les unités à associer aux durées (type RDF xsd:duration).

Stockage

Le bouton de sélection de l’unité est stocké dans la clé 'unit widget' du dictionnaire interne.

widgetsdict[widgetkey]['unit widget'] = unit_widget

Où unit_widget est le widget de sélection de l’unité qui vient d’être créé.

Menu

Le QMenu associé au QToolButton est stocké dans la clé 'unit menu' du dictionnaire.

widgetsdict[widgetkey]['unit menu'] = unit_menu

Où unit_menu est le QMenu qui vient d’être créé.

Ce QMenu contient une QAction par unité disponible. Les QAction sont elles-mêmes stockées dans la clé 'unit actions' du dictionnaire, sous la forme d’une liste.

widgetsdict[widgetkey]['unit actions'].append(unit_action)

Où unit_action représente chaque QAction venant d’être créée.

Les libellés des QAction correspondent aux noms abrégés des langues et sont fournis par la liste contenue dans la clé 'units' du dictionnaire :

widgetsdict[widgetkey]['units']

Pour la définition des actions, cf. Actions contrôlées par les widgets du formulaire.

Rendu

Au lieu d’une icône, le QToolButton de sélection de l’unité montre un texte correspondant à l’unité sélectionnée. Celui-ci est fourni par la clé 'current unit'.

widgetsdict[widgetkey]['current unit']

L’unité sélectionnée est également mise en évidence dans le menu par l’icône selected_blue.svg : .

Texte d’aide

On pourra afficher en infobulle sur le bouton le texte suivant :

'Sélection de l'unité de mesure'

Placement dans la grille

Le QToolButton doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'unit widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(unit_widget, row, column, rowSpan, columnSpan)

unit_widget est le QToolButton qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du widget annexe de sélection de l’unité.

Widget masqué ?

Le QToolButton doit être masqué dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

↑ haut de page

Widget annexe : bouton d’aide à la saisie des géométries

Un widget QToolButton d’aide à la saisie des géométries doit être créé dès lors que la condition suivante est vérifiée :

if widgetsdict[widgetkey]['geo tools']:
    ...

De tels widgets accompagnent les widgets de saisie appelant des valeurs de type gsp:wktLiteral.

NB : Contrairement aux autres boutons, les boutons d’aide à la saisie peuvent apparaître en mode lecture. Ils n’offrent alors, bien évidemment, que des fonctionnalités de visualisation.

Stockage

Le bouton d’aide à la saisie des géométries est stocké dans la clé 'geo widget' du dictionnaire interne.

widgetsdict[widgetkey]['geo widget'] = geo_widget

Où geo_widget est le widget d’aide à la saisie des géométries qui vient d’être créé.

Menu

Le QMenu associé au QToolButton est stocké dans la clé 'geo menu' du dictionnaire.

widgetsdict[widgetkey]['geo menu'] = geo_menu

Où geo_menu est le QMenu qui vient d’être créé.

Ce QMenu contient une QAction par fonction d’assistance disponible. Les QAction sont elles-mêmes stockées dans la clé 'geo actions' du dictionnaire, sous la forme d’une liste.

widgetsdict[widgetkey]['geo actions'].append(geo_action)

Où geo_action représente chaque QAction venant d’être créée.

Les actions à faire apparaître dans le menu dépendent des valeurs listées par la clé 'geo tools'. Elles sont détaillées par Outils d’aide à la saisie des géométries.

Lorsque la liste de la clé 'geo tools' vaut exactement ['show'], on ne créera pas de QMenu, car l’action de visualisation est directement portée par le bouton, comme expliqué dans le paragraphe suivant.

Effet du bouton et icônes

Avec fonctionnalité de visualisation

Lorsque 'show' est inclus dans la liste de la clé 'geo tools', un clic gauche sur le bouton d’aide à la saisie des géométries doit permettre de visualiser dans le canevas de QGIS la géométrie enregistrée dans les métadonnées.

if 'show' in widgetsdict[widgetkey]['geo tools']:
    ...

Un second clic gauche sur le bouton efface la forme du canevas.

L’icône affichée sur le bouton dépend de l’état de visibilité de la géométrie.

Etat	Icône	Texte d’aide	Effet d’un clic gauche sur le bouton
Géométrie non visible dans le canevas	- fichier /geo/show.svg	Afficher la géométrie dans le canevas	Affiche dans le canevas la géométrie renseignée dans le widget de saisie
Géométrie visible dans le canevas	- fichier /geo/hide.svg	Effacer la géométrie du canevas	Efface la géométrie du canevas

Cliquer sur le bouton ne devrait avoir aucun effet s’il n’y a pas de valeur dans le widget de saisie, ou s’il ne s’agit pas d’une représentation WKT valide. Les modalités d’interprétation des WKT stockés dans le widgets sont décrites dans la page Outils d’aide à la saisie des géométries.

Si le référentiel utilisé pour la géométrie est différent du référentiel courant du canevas, il sera nécessaire de re-projeter la géométrie dans le référentiel du canevas avant de l’afficher.

Il pourrait par ailleurs être intéressant d’ajuster automatiquement l’emprise et l’échelle du canevas en fonction de la géométrie.

Sans fonctionnalité de visualisation

Lorsque 'show' n’est pas inclus dans la liste de la clé 'geo tools', cliquer sur le bouton n’a aucun effet, seul son menu associé permet d’interagir avec les géométries. Dans ce cas, l’icône à faire apparaître sur le bouton d’aide à la saisie des géométries sera plutôt (fichier geo_button.svg).

On pourra afficher en infobulle sur le bouton le texte suivant :

'Aide à la saisie des géométries'

Icônes des actions

Les actions du menu associé au bouton ont chacune leur icône. Les SVG se trouvent dans le répertoire /plume/icons/buttons/geo, cf. Outils d’aide à la saisie des géométries pour les noms des fichiers.

Placement dans la grille

Le QToolButton doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'geo widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(geo_widget, row, column, rowSpan, columnSpan)

geo_widget est le QToolButton qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du widget annexe d’aide à la saisie des géométries.

Widget masqué ?

Le QToolButton doit être masqué dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

↑ haut de page

Widget annexe : bouton « moins »

Pour les propriétés admettant des valeurs multiples ou des traductions, des widgets QToolButton permettent à l’utilisateur de supprimer les valeurs précédemment saisies, à condition qu’il en reste au moins une.

Un tel widget doit être créé dès lors que la condition suivante est vérifiée :

if widgetsdict[widgetkey]['has minus button']:
    ...

Stockage

Le boutoin moins est stocké dans la clé 'minus widget' du dictionnaire interne.

widgetsdict[widgetkey]['minus widget'] = minus_widget

Où minus_widget est le widget bouton moins qui vient d’être créé.

Placement dans la grille

Le QToolButton doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'minus widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(minus_widget, row, column, rowSpan, columnSpan)

minus_widget est le QToolButton qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du boutoin moins.

Icône

L’image à utiliser pour un bouton moins est toujours minus_button.svg, mais la couleur dépendra du type de groupe dans lequel se trouve le bouton, soit de la valeur renvoyée par :

widgetsdict.group_kind(widgetkey)

Comme pour les QGroupBox et les boutons plus/boutons de traduction, on pourra utiliser les valeurs par défaut suivantes :

Type de groupe	group_kind(widgetkey)	Couleur
Groupe de propriétés	'group of properties'	'#958B62'
Groupe de valeurs	'group of values'	'#5770BE'
Groupe de traduction	'translation group'	'#FF8D7E'

NB. En pratique, il n’y a pas de bouton moins dans les groupes de propriétés, donc la couleur associée ne sera jamais utilisée dans ce contexte.

Soit color la couleur souhaitée pour le bouton et raw_svg le contenu du fichier minus_button.svg, on pourra appliquer la couleur avec :

colored_svg = raw_svg.format(fill=color)

Texte d’aide

On pourra afficher en infobulle sur le bouton le texte suivant :

'Supprimer l'élément'

Widget masqué ?

Comme tous les autres widgets, le QToolButton doit être masqué dès lors que la clé 'hidden' vaut True. Mais il devra également être masqué si le groupe de traduction ou groupe de valeurs ne contient qu’un élément, soit quand 'hide minus button' vaut True.

if widgetsdict[widgetkey]['hidden'] or widgetsdict[widgetkey]['hide minus button']:
    ...

↑ haut de page

Widget annexe : bouton de calcul

Les boutons de calcul sont une alternative à la saisie manuelle des métadonnées. Ils permettent de calculer leurs valeurs par requête sur le serveur PostgreSQL.

Un tel widget doit être créé dès lors que la condition suivante est vérifiée :

if widgetsdict[widgetkey]['has compute button']:
    ...

Stockage

Le bouton de calcul est stocké dans la clé 'compute widget' du dictionnaire interne.

widgetsdict[widgetkey]['compute widget'] = compute_widget

Où compute_widget est le widget bouton de calcul qui vient d’être créé.

Placement dans la grille

Le QToolButton doit être placé dans le QGridLayout associé à la clé parente, obtenu grâce à la méthode plume.rdf.widgetsdict.WidgetsDict.parent_grid.

Les paramètres de placement du widget dans la grille - soit les arguments row, column, rowSpan et columnSpan de la méthode QGridLayout.addWidget - sont donnés par la méthode plume.rdf.widgetsdict.WidgetsDict.widget_placement.

row, column, rowSpan, columnSpan = widgetsdict.widget_placement(widgetkey, 'compute widget')
grid = widgetsdict.parent_grid(widgetkey)
grid.addWidget(compute_widget, row, column, rowSpan, columnSpan)

compute_widget est le QToolButton qui vient d’être créé. Le second paramètre de widget_placement indique que les coordonnées demandées sont celles du bouton de calcul.

Icône

L’image à utiliser pour un bouton de calcul est toujours compute_button.svg.

Texte d’aide

On pourra afficher en infobulle sur le bouton le texte obtenu comme suit, qui fournit une description détaillée de l’information effectivement importée depuis le serveur.

help_text = widgetsdict[widgetkey]['compute method'].description

Widget masqué ?

Comme tous les autres widgets, le QToolButton doit être masqué dès lors que la clé 'hidden' vaut True.

if widgetsdict[widgetkey]['hidden']:
    ...

↑ haut de page