Class QfSearchBar

ClassList > QfSearchBar

Inherits the following classes: QtQuick::Item

Public Properties

Type	Name
property alias	contents
property bool	enableFilterButton
property bool	filterActive
property var	parameterKeys
property string	placeHolderText
property real	searchHeight
property alias	searchTerm

Public Signals

Type	Name
signal void	cleared
signal void	filterClicked
signal void	searchTermEdited
signal void	searchTriggered

Public Functions

Type	Name
void	clear ()
void	focusOnTextField ()
void	highlightedText (raw)
void	setSearchTerm (term)

Public Properties Documentation

property contents

alias QfSearchBar::contents;

Remark:

This is the default property

---

property enableFilterButton

bool QfSearchBar::enableFilterButton;

---

property filterActive

bool QfSearchBar::filterActive;

---

property parameterKeys

var QfSearchBar::parameterKeys;

---

property placeHolderText

string QfSearchBar::placeHolderText;

---

property searchHeight

real QfSearchBar::searchHeight;

Remark:

This property is read-only

---

property searchTerm

alias QfSearchBar::searchTerm;

Remark:

This property is read-only

---

Public Signals Documentation

signal cleared

void QfSearchBar::cleared;

---

signal filterClicked

void QfSearchBar::filterClicked;

---

signal searchTermEdited

void QfSearchBar::searchTermEdited;

---

signal searchTriggered

void QfSearchBar::searchTriggered;

---

Public Functions Documentation

function clear

void QfSearchBar::clear () 

---

function focusOnTextField

void QfSearchBar::focusOnTextField () 

---

function highlightedText

void QfSearchBar::highlightedText (
    raw
) 

---

function setSearchTerm

void QfSearchBar::setSearchTerm (
    term
) 

---

---

The documentation for this class was generated from the following file src/gui/qml/QfSearchBar.qml