SearchPopupField
Inherits QtQuick::Controls::Control.
Properties | |
alias | autoAccept |
alias | delaySearch |
alias | fieldFocus |
alias | popup |
alias | popupContentItem |
KirigamiSearchField | searchField |
bool | spaceAvailableLeft |
bool | spaceAvailableRight |
alias | text |
Signals | |
void | accepted () |
Detailed Description
SearchField with a Popup to show autocompletion entries or search results.
- Since
- KirigamiAddons.labs.components 1.0
Definition at line 18 of file SearchPopupField.qml.
Property Documentation
◆ autoAccept
|
read |
This property sets whether the accepted signal is fired automatically when the text is changed.
Setting this to false will require that the user presses return or enter (the same way a QtQuick.Controls.TextInput works).
default: false
- Since
- KirigamiAddons.labs.components 1.0
Definition at line 80 of file SearchPopupField.qml.
◆ delaySearch
|
read |
This property sets whether to delay automatic acceptance of the search input.
Set this to true if your search is expensive (such as for online operations or in exceptionally slow data sets) and want to delay it for 2.5 seconds.
- Note
- If you must have immediate feedback (filter-style), use the text property directly instead of accepted()
default: false
- Since
- KirigamiAddons.labs.components 1.0
Definition at line 68 of file SearchPopupField.qml.
◆ fieldFocus
|
read |
This hold the focus state of the internal SearchField.
Definition at line 102 of file SearchPopupField.qml.
◆ popup
|
read |
Definition at line 108 of file SearchPopupField.qml.
◆ popupContentItem
|
read |
This property holds the content item of the popup.
Overflow will be automatically be handled as popupContentItem is contained inside a ScrollView.
This is the default element of SearchPopupField.
- Since
- KirigamiAddons.labs.components 1.0
- Remarks
- This is the default property
Definition at line 47 of file SearchPopupField.qml.
◆ searchField
|
read |
Definition at line 110 of file SearchPopupField.qml.
◆ spaceAvailableLeft
|
read |
This property holds whether there is space available on the left.
This is used by the left shadow.
- Since
- KirigamiAddons.labs.components 1.0
- Deprecated
- Was not really used by anything.
Definition at line 89 of file SearchPopupField.qml.
◆ spaceAvailableRight
|
read |
This property holds whether there is space available on the left.
This is used by the right shadow.
- Since
- KirigamiAddons.labs.components 1.0
- Deprecated
- Was not really used by anything.
Definition at line 98 of file SearchPopupField.qml.
◆ text
|
read |
This property holds the text of the search field.
- Since
- KirigamiAddons.labs.components 1.0
Definition at line 53 of file SearchPopupField.qml.
Member Function Documentation
◆ accepted
|
signal |
This signal is triggered when the user trigger a search.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:16:11 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.