src/controls.6/SearchField.qml

0001 /*
0002  *   Copyright 2018 Camilo Higuita <milo.h@aol.com>
0003  *
0004  *   This program is free software; you can redistribute it and/or modify
0005  *   it under the terms of the GNU Library General Public License as
0006  *   published by the Free Software Foundation; either version 2, or
0007  *   (at your option) any later version.
0008  *
0009  *   This program is distributed in the hope that it will be useful,
0010  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0012  *   GNU General Public License for more details
0013  *
0014  *   You should have received a copy of the GNU Library General Public
0015  *   License along with this program; if not, write to the
0016  *   Free Software Foundation, Inc.,
0017  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
0018  */
0019
0020 import QtQuick
0021 import QtQuick.Controls
0022
0023 /**
0024  * @inherit QtQuick.Controls.TextField
0025  * @brief This is just a QQC2 TextField with a icon to more clearly indicate its intended use case for entering search queries
0026  * <a href="https://doc.qt.io/qt-6/qml-qtquick-controls-textfield.html">This control inherits from QQC2 TextField, to checkout its inherited properties refer to the Qt Docs.</a>
0027  *
0028  *  @section notes Notes
0029  *  Some TextField properties have been added to the Maui Style, so they have been obscured, those properties are:
0030  *
0031  *  - `spacing : int` The spacing between the action buttons, added via the `actions` property.
0032  *  - `menu : Menu` An alias to access the contextual menu, containing entries, such as Copy, Cut, Paste, etc. More entries could be dynamically added using the Menu methods.
0033  *  - `actions : list<Action>` A set of actions, that will be represented inside of the text field box as flat icons.
0034  *  - `icon : Icon` The icon to be used in the text field left area. This is an extra visual hint to let the user know what the text field is for, besides the use of the `placeholdertext` property.
0035  *  - `rightContent : list<QtObject>` An alias to allow adding arbitrary content inside of the right area of the text field box.
0036  *
0037  *  - `cleared()` Emitted when the text field has been cleared using the clear action button.
0038  *  - `contentDropped(drop)` Emitted when some content has been drag and dropped on the text field area. The `drop` parameter has the information on the event.
0039  */
0040 TextField
0041 {
0042     id: control
0043     icon.source: "edit-find"
0044 }