SearchField QML Type
Un champ de saisie spécialisé conçu pour être utilisé dans le cadre d'une fonction de recherche. Plus...
| Import Statement: | import QtQuick.Controls |
| Since: | Qt 6.10 |
| Inherits: |
Propriétés
- clearIndicator : real
- currentIndex : int
- delegate : Component
- delegateModel : model
- highlightedIndex : int
- live : bool
- popup : Popup
- searchIndicator : real
- suggestionCount : int
- suggestionModel : model
- text : string
- textRole : string
Signaux
- void accepted()
- void activated(int index)
- void highlighted(int index)
- void searchTriggered()
- void textEdited()
Description détaillée
SearchField est un champ de saisie spécialisé conçu pour les fonctions de recherche. Le contrôle comprend un champ de texte, des icônes de recherche et d'effacement, ainsi qu'une fenêtre contextuelle qui affiche des suggestions ou des résultats de recherche.
Rôles du modèle SearchField
SearchField est capable de visualiser des modèles de données standard qui fournissent le rôle modelData:
- les modèles qui n'ont qu'un seul rôle
- les modèles qui n'ont pas de rôle nommé (tableau JavaScript, entier).
Lors de l'utilisation de modèles ayant plusieurs rôles nommés, SearchField doit être configuré pour utiliser un text role spécifique pour ses instances text et delegate.
ListModel {
id : fruitModel
ListElement { name: "Apple"; color: "green" }
ListElement { name: "Cherry"; color: "red" }
ListElement { name: "Banana"; color: "yellow" }
ListElement { name: "Orange"; color: "orange" }
ListElement { name: "WaterMelon"; color: "pink" }
}
QSortFilterProxyModel {
id: fruitFilter
sourceModel: fruitModel
filterRegularExpression: RegExp(fruitSearch.text, "i")
filterRole: 0 // needs to be set explicitly
}
SearchField {
id: fruitSearch
suggestionModel: fruitFilter
textRole: "name"
anchors.horizontalCenter: parent.horizontalCenter
}Propriété Documentation
clearIndicator : real |
Cette propriété contient l'indicateur de clarté.
currentIndex : int |
Cette propriété contient l'index de la suggestion actuellement sélectionnée dans la liste déroulante.
La valeur par défaut est -1 lorsque le nombre est 0, et 0 dans le cas contraire.
Voir également activated(), text et highlightedIndex.
delegate : Component |
Cette propriété contient un délégué qui présente un élément dans la fenêtre contextuelle du champ de recherche.
Il est recommandé d'utiliser ItemDelegate (ou tout autre dérivé de AbstractButton ) comme délégué. Cela garantit que l'interaction fonctionne comme prévu et que la fenêtre contextuelle se ferme automatiquement le cas échéant. Lorsque d'autres types sont utilisés comme délégués, la fenêtre contextuelle doit être fermée manuellement. Par exemple, si MouseArea est utilisé :
delegate: Rectangle {
// ...
MouseArea {
// ...
onClicked: searchField.popup.close()
}
}
delegateModel : model |
Cette propriété contient le modèle qui fournit des instances de délégué pour le champ de recherche.
Elle est généralement attribuée à un ListView dans le contentItem du popup.
highlightedIndex : int |
Cette propriété contient l'index de l'élément actuellement mis en évidence dans la liste déroulante.
Lorsque l'élément en surbrillance est activé, la fenêtre contextuelle se ferme, currentIndex est mis à jour pour correspondre à highlightedIndex, et cette propriété est réinitialisée à -1, ce qui indique qu'aucun élément n'est actuellement en surbrillance.
Voir également highlighted() et currentIndex.
live : bool |
Cette propriété contient une valeur booléenne qui détermine si la recherche est déclenchée à chaque modification de texte.
Lorsque cette propriété vaut true, le signal searchTriggered() est émis à chaque modification du texte, ce qui vous permet de réagir à chaque frappe au clavier. Si la valeur est false, le signal searchTriggered() n'est émis que lorsque l'utilisateur appuie sur la touche Entrée ou Retour.
Voir également searchTriggered().
popup : Popup |
Cette propriété contient la fenêtre contextuelle.
La fenêtre contextuelle peut être ouverte ou fermée manuellement, si nécessaire :
onSpecialEvent: searchField.popup.close()
searchIndicator : real |
Cette propriété contient l'indicateur de recherche.
suggestionCount : int |
Cette propriété contient le nombre de suggestions à afficher à partir du modèle de suggestion.
suggestionModel : model |
Cette propriété contient le modèle de données utilisé pour afficher les suggestions de recherche dans le menu contextuel.
SearchField { textRole: "age" suggestionModel: ListModel { ListElement { name: "Karen"; age: "66" } ListElement { name: "Jim"; age: "32" } ListElement { name: "Pamela"; age: "28" } } }
Voir également textRole.
text : string |
Cette propriété contient le texte actuellement saisi dans le champ de recherche.
Le texte est lié à la saisie de l'utilisateur, ce qui déclenche la mise à jour des suggestions ou la logique de recherche.
Voir également searchTriggered() et textEdited().
textRole : string |
Cette propriété contient le rôle du modèle utilisé pour afficher les éléments du modèle de suggestion figurant dans la liste déroulante.
Lorsque le modèle a plusieurs rôles, textRole peut être défini pour déterminer quel rôle doit être affiché.
Signal Documentation
void accepted() |
Ce signal est émis lorsque l'utilisateur confirme sa saisie en appuyant sur la touche Entrée ou Retour.
Ce signal est généralement utilisé pour déclencher une recherche ou une action en fonction du texte final saisi, et il indique l'intention de l'utilisateur de terminer ou de soumettre la requête.
Remarque : le gestionnaire correspondant est onAccepted.
Voir également searchTriggered().
void activated(int index) |
Ce signal est émis lorsque l'élément situé à l'adresse index est activé par l'utilisateur.
Un élément est activé lorsqu'il est sélectionné alors que la fenêtre contextuelle est ouverte, ce qui entraîne la fermeture de la fenêtre (et la modification de currentIndex ). La propriété currentIndex est remplacée par index.
Remarque : le gestionnaire correspondant est onActivated.
Voir également currentIndex.
void highlighted(int index) |
Ce signal est émis lorsque l'élément situé à l'adresse index dans la liste déroulante est mis en évidence par l'utilisateur.
Le signal de mise en évidence n'est émis que lorsque la fenêtre contextuelle est ouverte et qu'un élément est mis en évidence, mais pas nécessairement à l'adresse activated.
Remarque : le gestionnaire correspondant est onHighlighted.
Voir également highlightedIndex.
void searchTriggered() |
Ce signal est émis lorsqu'une action de recherche est lancée.
Il se produit dans deux cas : 1. Lorsque l'on appuie sur la touche Entrée ou Retour, il est émis en même temps que le signal accepted() 2. Lorsque le texte est modifié et que la propriété live est définie sur true, ce signal est émis.
Ce signal est idéal pour lancer des recherches à la fois à la demande et en temps réel au fur et à mesure que l'utilisateur tape, en fonction du modèle d'interaction souhaité.
Remarque : le gestionnaire correspondant est onSearchTriggered.
Voir également accepted() et textEdited().
void textEdited() |
Ce signal est émis chaque fois que l'utilisateur modifie le texte dans le champ de recherche, généralement à chaque frappe.
Remarque : le gestionnaire correspondant est onTextEdited.
Voir aussi searchTriggered().
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.