Class Theme::QfSearchBar

ClassList > Theme > QfSearchBar

More...

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)

Detailed Description

Import Statement

import Theme 

Version:

1.0

Public Properties Documentation

property contents

alias Theme::QfSearchBar::contents;

Remark:

This is the default property

---

property enableFilterButton

bool Theme::QfSearchBar::enableFilterButton;

---

property filterActive

bool Theme::QfSearchBar::filterActive;

---

property parameterKeys

var Theme::QfSearchBar::parameterKeys;

---

property placeHolderText

string Theme::QfSearchBar::placeHolderText;

---

property searchHeight

real Theme::QfSearchBar::searchHeight;

Remark:

This property is read-only

---

property searchTerm

alias Theme::QfSearchBar::searchTerm;

Remark:

This property is read-only

---

Public Signals Documentation

signal cleared

void Theme::QfSearchBar::cleared;

---

signal filterClicked

void Theme::QfSearchBar::filterClicked;

---

signal searchTermEdited

void Theme::QfSearchBar::searchTermEdited;

---

signal searchTriggered

void Theme::QfSearchBar::searchTriggered;

---

Public Functions Documentation

function clear

void Theme::QfSearchBar::clear () 

---

function focusOnTextField

void Theme::QfSearchBar::focusOnTextField () 

---

function highlightedText

void Theme::QfSearchBar::highlightedText (
    raw
) 

---

function setSearchTerm

void Theme::QfSearchBar::setSearchTerm (
    term
) 

---

---

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