QInputMethodEvent

La classe QInputMethodEvent fournit les paramètres pour les événements de méthode de saisie. Plus d'informations...

#include <QInputMethodEvent>

Voir la position dans l'arbre des classes.

Héritage

Hérite de QEvent.

Description détaillée

La classe QInputMethodEvent fournit les paramètres pour les événements de méthode de saisie.

Les événements de méthode de saisie sont envoyés aux widgets quand une méthode de saisie est utilisée pour entrer du texte dans un widget. Les méthodes de saisie sont largement utilisées pour saisir du texte dans une langue avec des caractères non-latin.

Notez que lors de la création de widgets personnalisés d'édition de texte, l'attribut de fenêtre Qt::WA_InputMethodEnabled doit être défini de façon explicite (en utilisant la fonction QWidget::setAttribute()), de manière à recevoir les événements de méthode de saisie.

Les événements sont intéressants pour les auteurs de widgets de saisie clavier qui veulent être en mesure de gérer correctement les langages avec la saisie de caractères complexes.

1. Début de la saisie

Quand l'utilisateur appuie sur la première touche sur un clavier, un contexte de saisie est créé. Ce contexte de saisie contiendra une chaîne des caractères tapés.

1. Saisie

Avec chaque nouvelle touche pressée, la méthode de saisie tentera de créer une chaîne correspondante pour le texte tapé jusque-là appelé chaîne de préédition. Tant que le contexte est activé, l'utilisateur peut seulement déplacer le curseur à l'intérieur de la chaîne appartenant à ce contexte de saisie.

1. Complétion

À un certain moment, l'utilisateur activera un composant de l'interface utilisateur (peut-être en utilisant une touche particulière) où il peut choisir parmi un nombre de chaînes correspondant au texte qu'il a entré jusqu'à maintenant. L'utilisateur peut soit confirmer son choix, soit l'annuler ; dans tous les cas, le contexte de saisie sera fermé.

QInputMethodEvent modélise ces trois étapes et transfère l'information nécessaire pour afficher correctement le résultat intermédiaire. QInputMethodEvent possède deux paramètres principaux : preeditString() etcommitString(). Le paramètre preeditString() fournit la chaîne de préédition actuellement active. Le paramètre commitString() fournit un texte qui devrait être ajouté au (ou remplacer des parties du) texte du widget d'édition. Il est habituellement un résultat des opérations d'entrée et doit être inséré dans le texte des widgets directement avant la chaîne de préédition.

Si commitString() doit remplacer des parties du texte dans l'éditeur, replacementLength() contiendra le nombre de caractères qui seront remplacés. replacementStart() contient la position à laquelle les caractères doivent être remplacés par rapport au début de la chaîne de préédition.

Certains attributs contrôlent l'apparence visuelle de la chaîne de préédition (l'apparence visuelle du texte en dehors de la chaîne de préédition est contrôlée par le widget même). L'énumération AttributeType décrit les différents attributs qui peuvent être activés.

Une classe implémentant QWidget::inputMethodEvent() ou QGraphicsItem::inputMethodEvent() devrait au moins savoir interpréter et honorer les attributs TextFormat et Cursor.

Depuis que les méthodes de saisie ont besoin de pouvoir demander certaines propriétés au widget ou à l'item graphique, les sous-classes doivent également implémenter QWidget::inputMethodQuery() et QGraphicsItem::inputMethodQuery(), respectivement.

À la réception d'un événement de méthode de saisie, le widget du texte doit effectuer les étapes suivantes :

1. Si le widget a sélectionné le texte, le texte sélectionné doit être supprimé ;
2. Supprimer le texte commençant à replacementStart() avec une longueur de replacementLength() et le remplacer par le commitString(). Si replacementLength() vaut 0, replacementStart() fournit la position de l'insertion pour le commitString().

Lorsque le remplacement fait que la zone de la chaîne de préédition est ignorée, c'est-à-dire un remplacement commençant à -1 avec une longueur de 2, il supprimera le dernier caractère avant la chaîne de préédition et le premier caractère juste après et insèrera la chaîne mémorisée directement avant la chaîne de préédition.

Si le widget implémente annuler/refaire, cette opération est ajoutée à la pile d'annulation.

1. S'l n'y a pas de chaîne de préédition courante, insérer le preeditString() à la position courante du curseur ; autrement remplacer la chaîne de préédition précédente avec celle reçue depuis l'événement.

Si le widget implémente annluer/refaire, le preeditString() ne devrait en aucune façon influencer la pile de annuler/refaire.

Le widget devrait examiner la liste des attributs à appliquer sur la chaîne de préédition. Il doit pouvoir interpréter au minimum les attributs TextFormat et Cursor en les affichant comme spécifié.

Voir aussi QInputContext.

Type

enum QInputMethodEvent::AttributeType

Voir aussi Attribute.

Fonctions membres

QInputMethodEvent::QInputMethodEvent ()

Construit un événement de type QEvent::InputMethod. attributes(), preeditString(), commitString(), replacementStart() et replacementLength() sont initialisés aux valeurs par défaut.

Voir aussi setCommitString().

QInputMethodEvent::QInputMethodEvent ( const QString & preeditText, const QList<Attribute> & attributes )

Construit un événement de type QEvent::InputMethod. Le texte de préédition est défini à preeditText, les attributs à attributes.

Les valeurs commitString(), replacementStart() et replacementLength() peuvent être fixées en utilisant setCommitString().

Voir aussi preeditString() et attributes().

QInputMethodEvent::QInputMethodEvent ( const QInputMethodEvent & other )

Construit une copie de other.

const QList<Attribute> & QInputMethodEvent::attributes () const

Retourne la list des attributs passés au constructeur de QInputMethodEvent. Les attributs contrôlent l'apparence visuelle de la chaîne de préédition (l'apparence visuelle du texte en dehors de la chaîne de préédition est contrôlée par le widget même).

Voir aussi preeditString() et Attribute.

const QString & QInputMethodEvent::commitString () const

Retourne le texte qui devrait être ajouté au (ou remplacer une partie du) texte du widget éditeur. Il est généralement le résultat des opérations d'entrée et doit être inséré dans le texte du widget juste avant la chaîne de préédition.

Voir aussi setCommitString(), preeditString(), replacementStart() et replacementLength().

const QString & QInputMethodEvent::preeditString () const

Retourne le texte de préédition, c'est-à-dire le texte avant que l'utilisateur n'ait commencé à l'éditer.

Voir aussi commitString() et attributes().

int QInputMethodEvent::replacementLength () const

Retourne le nombre de caractères à remplacer dans la chaîne de préédition.

Voir aussi replacementStart() et setCommitString().

int QInputMethodEvent::replacementStart () const

Retourne la position à laquelle les caractères doivent être remplacés par rapport au début de la chaîne de préédition.

Voir aussi replacementLength() et setCommitString().

void QInputMethodEvent::setCommitString ( const QString & commitString, int replaceFrom = 0, int replaceLength = 0 )

Définit la chaîne mémorisée à commitString.

La chaîne mémorisée est le texte qui devrait être ajouté au (ou remplacer des parties du) texte du widget éditeur. Elle est généralement le résultat des opérations d'entrée et doit être insérée dans le texte du widget juste avant la chaîne de préédition.

Si la chaîne mémorisée doit remplacer une partie du texte dans l'éditeur, replaceLength spécifie le nombre de caractères à remplacer. replaceFrom spécifie la position à laquelle les caractères doivent être remplacés par rapport au début de la chaîne de préédition.

Voir aussi commitString(), replacementStart() et replacementLength().

Remerciements

Merci à Dimitry Ernot pour la traduction et à Jonathan Courtois ainsi qu'à Jacques Thery pour leur relecture !